Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
workspaces-ag-207	workspaces-ag.pdf	207	VPC with a public subnet. For more information, see Conﬁgure a New or Existing VPC with a Public Subnet. You can enable internet access when you create the WorkSpaces Pool directory. Choose the default VPC when you create the directory. The default VPC name uses the following format: vpc-vpc-id (No_default_value_Name). Then select a default public subnet for Subnet 1 and, optionally, another default public subnet for Subnet 2. The default subnet names use the following format: subnet-subnet-id \| (IPv4 CIDR block) \| Default in availability-zone. You can test your internet connectivity by starting your WorkSpaces Pool, and then connecting to a WorkSpace in the pool and browsing to the internet. Conﬁgure FedRAMP authorization or DoD SRG compliance for WorkSpaces Pools To comply with the Federal Risk and Authorization Management Program (FedRAMP) or the Department of Defense (DoD) Cloud Computing Security Requirements Guide (SRG), you must conﬁgure Amazon WorkSpaces Pools to use Federal Information Processing Standards (FIPS) endpoint encryption at the directory level. You must also use a US AWS Region that has FedRAMP authorization or is DoD SRG compliant. The level of FedRAMP authorization (Moderate or High) or DoD SRG Impact Level (2, 4, or 5) depends on the US AWS Region in which Amazon WorkSpaces is being used. For the levels of FedRAMP authorization and DoD SRG compliance that apply to each Region, see AWS Services in Scope by Compliance Program. Conﬁgure FIPS endpoint encryption 624 Amazon WorkSpaces Requirements Administration Guide • The WorkSpaces Pools directory must be conﬁgured to use FIPS 140-2 Validated Mode for endpoint encryption. Note To use the FIPS 140-2 Validated Mode setting, ensure the following: • The WorkSpaces Pools directory is either: • New and not associated with a Pool • Associated with an existing Pool that is in the STOPPED state • The Pool directory has StreamingExperiencePreferredProtocol set to TCP. • You must create your WorkSpaces Pools in a US AWS Region that has FedRAMP authorization or is DoD SRG-compliant. • Users must access their WorkSpaces from one of the following WorkSpaces client applications: • macOS: 5.20.0 or later • Windows: 5.20.0 or later • Web Access To use FIPS endpoint encryption 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories then choose the directory that you want to use for FedRAMP authorization and DoD SRG compliance. 3. On the Directory Details page, choose the directory that you want to conﬁgure for FIPS encryption mode. 4. In the Endpoint encryption section, choose Edit and then select FIPS 140-2 Validated Mode. 5. Choose Save. Using Amazon S3 VPC Endpoints for WorkSpaces Pools Features When you enable Application Settings Persistence for a WorkSpaces Pool or Home folders for a WorkSpaces Pool directory, WorkSpaces uses the VPC you specify for your directory to provide access to Amazon Simple Storage Service (Amazon S3) buckets. To enable WorkSpaces Pools access Amazon S3 VPC Endpoints 625 Amazon WorkSpaces Administration Guide to your private S3 endpoint, attach the following custom policy to your VPC endpoint for Amazon S3. For more information about private Amazon S3 endpoints, see VPC Endpoints and Endpoints for Amazon S3 in the Amazon VPC User Guide. Commercial AWS Regions Use the following policy for resources in the commercial AWS Regions. { "Version": "2012-10-17", "Statement": [ { "Sid": "Allow-WorkSpaces-to-access-S3-buckets", "Effect": "Allow", "Principal": { "AWS": "arn:aws:sts::<account-id>:assumed-role/ workspaces_DefaultRole/WorkSpacesPoolSession" }, "Action": [ "s3:ListBucket", "s3:GetObject", "s3:PutObject", "s3:DeleteObject", "s3:GetObjectVersion", "s3:DeleteObjectVersion" ], "Resource": [ "arn:aws:s3:::wspool-logs-", "arn:aws:s3:::wspool-app-settings-", "arn:aws:s3:::wspool-home-folder-" ] } ] } AWS GovCloud (US) Regions Use the following policy for resources in the commercial AWS GovCloud (US) Regions. { "Version": "2012-10-17", "Statement": [ { Amazon S3 VPC Endpoints 626 Amazon WorkSpaces Administration Guide "Sid": "Allow-WorkSpaces-to-access-S3-buckets", "Effect": "Allow", "Principal": { "AWS": "arn:aws:sts::<account-id>:assumed-role/ workspaces_DefaultRole/WorkSpacesPoolSession" }, "Action": [ "s3:ListBucket", "s3:GetObject", "s3:PutObject", "s3:DeleteObject", "s3:GetObjectVersion", "s3:DeleteObjectVersion" ], "Resource": [ "arn:aws-us-gov:s3:::wspool-logs-", "arn:aws-us-gov:s3:::wspool-app-settings-", "arn:aws-us-gov:s3:::wspool-home-folder-" ], } ] } Connections to Your VPC for WorkSpaces Pools To enable WorkSpaces Pools connectivity to network resources and the internet, conﬁgure your WorkSpaces as follows. Network Interfaces Each WorkSpaces in WorkSpaces Pools has the following network interfaces: • The customer network interface provides connectivity to the resources within your VPC, as well as the internet, and is used to join the WorkSpaces to your directory. • The management network interface is connected to a secure WorkSpaces Pools management network. It is used for interactive streaming of the WorkSpace to a user's device, and to allow WorkSpaces Pools to manage the WorkSpace. WorkSpaces Pools selects the IP address for the management network interface from the following private IP address range: 198.19.0.0/16. Do not use this range for your VPC CIDR or peer your Connections to Your VPC 627 Amazon WorkSpaces Administration Guide VPC with another VPC with this range, as this might create a conﬂict and cause WorkSpaces to be unreachable. Also, do not modify or delete any of the
workspaces-ag-208	workspaces-ag.pdf	208	interface is connected to a secure WorkSpaces Pools management network. It is used for interactive streaming of the WorkSpace to a user's device, and to allow WorkSpaces Pools to manage the WorkSpace. WorkSpaces Pools selects the IP address for the management network interface from the following private IP address range: 198.19.0.0/16. Do not use this range for your VPC CIDR or peer your Connections to Your VPC 627 Amazon WorkSpaces Administration Guide VPC with another VPC with this range, as this might create a conﬂict and cause WorkSpaces to be unreachable. Also, do not modify or delete any of the network interfaces attached to a WorkSpace, as this might also cause the WorkSpace to become unreachable. Management Network Interface IP Address Range and Ports The management network interface IP address range is 198.19.0.0/16. The following ports must be open on the management network interface of all WorkSpaces: • Inbound TCP on port 8300. This is used for establishment of the streaming connection. • Outbound TCP on port 3128. This is used for management of WorkSpaces. • Inbound TCP on ports 8000 and 8443. These are used for management of the WorkSpaces. • Inbound UDP on port 8300. This is used for establishment of the streaming connection over UDP. Limit the inbound range on the management network interface to 198.19.0.0/16. Note For Amazon DCV BYOL Windows WorkSpaces Pools, the 10.0.0.0/8 IP address ranges are used in all AWS Regions. These IP ranges are in addition to the /16 CIDR block that you choose for management traﬃc in your BYOL WorkSpaces Pools. Under normal circumstances, WorkSpaces Pools correctly conﬁgures these ports for your WorkSpaces. If any security or ﬁrewall software is installed on a WorkSpace that blocks any of these ports, the WorkSpaces might not function correctly or might be unreachable. Do not disable IPv6. If you disable IPv6, WorkSpaces Pools will not function correctly. For information about conﬁguring IPv6 for Windows, see Guidance for conﬁguring IPv6 in Windows for advanced users. Note WorkSpaces Pools relies on the DNS servers within your VPC to return a non-existent domain (NXDOMAIN) response for local domain names that don’t exist. This enables the WorkSpaces Pools-managed network interface to communicate with the management servers. Connections to Your VPC 628 Amazon WorkSpaces Administration Guide When you create a directory with Simple AD, AWS Directory Service creates two domain controllers that also function as DNS servers on your behalf. Because the domain controllers don't provide the NXDOMAIN response, they can't be used with WorkSpaces Pools. Customer Network Interface Ports • For internet connectivity, the following ports must be open to all destinations. If you are using a modiﬁed or custom security group, you need to add the required rules manually. For more information, see Security Group Rules in the Amazon VPC User Guide. • TCP 80 (HTTP) • TCP 443 (HTTPS) • UDP 4195 • If you join your WorkSpaces to a directory, the following ports must be open between your WorkSpaces Pools VPC and your directory controllers. • TCP/UDP 53 - DNS • TCP/UDP 88 - Kerberos authentication • UDP 123 - NTP • TCP 135 - RPC • UDP 137-138 - Netlogon • TCP 139 - Netlogon • TCP/UDP 389 - LDAP • TCP/UDP 445 - SMB • TCP 1024-65535 - Dynamic ports for RPC For a complete list of ports, see Active Directory and Active Directory Domain Services Port Requirements in the Microsoft documentation. • All WorkSpaces require that port 80 (HTTP) be open to IP address 169.254.169.254 to allow access to the EC2 metadata service. The IP address range 169.254.0.0/16 is reserved for WorkSpaces Pools service usage for management traﬃc. Failure to exclude this range might result in streaming issues. Connections to Your VPC 629 Amazon WorkSpaces Administration Guide User connections to WorkSpaces Pools Users can connect to WorkSpaces in WorkSpaces Pools through the default public internet endpoint. By default, WorkSpaces Pools is conﬁgured to route streaming connections over the public internet. Internet connectivity is required to authenticate users and deliver the web assets that WorkSpaces Pools requires to function. To allow this traﬃc, you must allow the domains listed in Allowed Domains. Note For user authentication, WorkSpaces Pools supports Security Assertion Markup Language 2.0 (SAML 2.0). For more information, see Conﬁgure SAML 2.0 and create a WorkSpaces Pools directory. The following topics provide information about how to enable user connections to WorkSpaces Pools. Contents • Bandwidth Recommendations • IP Address and Port Requirements for WorkSpaces Pools User Devices • Allowed Domains Bandwidth Recommendations To optimize the performance of WorkSpaces Pools, make sure that your network bandwidth and latency can sustain your users' needs. WorkSpaces Pools uses NICE Desktop Cloud Visualization (DCV) to enable your users to securely access and stream your applications over varying network conditions. To help reduce bandwidth consumption, NICE DCV
workspaces-ag-209	workspaces-ag.pdf	209	2.0 (SAML 2.0). For more information, see Conﬁgure SAML 2.0 and create a WorkSpaces Pools directory. The following topics provide information about how to enable user connections to WorkSpaces Pools. Contents • Bandwidth Recommendations • IP Address and Port Requirements for WorkSpaces Pools User Devices • Allowed Domains Bandwidth Recommendations To optimize the performance of WorkSpaces Pools, make sure that your network bandwidth and latency can sustain your users' needs. WorkSpaces Pools uses NICE Desktop Cloud Visualization (DCV) to enable your users to securely access and stream your applications over varying network conditions. To help reduce bandwidth consumption, NICE DCV uses H.264-based video compression and encoding. During streaming sessions, the visual output of applications is compressed and streamed to your users as an AES-256 encrypted pixel stream over HTTPS. After the stream is received, it is decrypted and output to your users’ local screen. When your users interact with their streaming applications, the NICE DCV protocol captures their input and sends it back to their streaming applications over HTTPS. User connections 630 Amazon WorkSpaces Administration Guide Network conditions are constantly measured during this process and information is sent back to WorkSpaces Pools. WorkSpaces Pools dynamically responds to changing network conditions by changing the video and audio encoding in real time to produce a high-quality stream for a wide variety of applications and network conditions. The recommended bandwidth and latency for WorkSpaces Pools streaming sessions depends on the workload. For example, a user who works with graphic-intensive applications to perform computer-aided design tasks will require more bandwidth and lower latency than a user who works with business productivity applications to write documents. The following table provides guidance on the recommended network bandwidth and latency for WorkSpaces Pools streaming sessions based on common workloads. For each workload, the bandwidth recommendation is based on what an individual user might require at a speciﬁc point in time. The recommendation does not reﬂect the bandwidth required for sustained throughput. When only a few pixels change on the screen during a streaming session, the sustained throughput is much lower. Although users who have less bandwidth available can still stream their applications, the frame rate or image quality may not be optimal. Workload Description Line of business applications Graphics applications High ﬁdelity Document writing applications, database analysis utilities Computer-aided design and modeling applicati ons, photo and video editing High-ﬁdelity datasets or maps across multiple monitors Bandwidth recommended per Recommend ed maximum user 2 Mbps roundtrip latency < 150 ms 5 Mbps < 100 ms 10 Mbps < 50 ms User connections 631 Amazon WorkSpaces Administration Guide IP Address and Port Requirements for WorkSpaces Pools User Devices WorkSpaces Pools users' devices require outbound access on port 443 (TCP) and port 4195 (UDP) when using the internet endpoints, and if you are using DNS servers for domain name resolution, port 53 (UDP). • Port 443 is used for HTTPS communication between WorkSpaces Pools users' devices and WorkSpaces when using the internet endpoints. Typically, when end users browse the web during streaming sessions, the web browser randomly selects a source port in the high range for streaming traﬃc. You must ensure that return traﬃc to this port is allowed. • Port 4195 is used for UDP HTTPS communication between WorkSpaces Pools users' devices and WorkSpaces when using the internet endpoints. This is currently only supported in the Windows native client. UDP is not supported if you are using VPC endpoints. • Port 53 is used for communication between WorkSpaces Pools users' devices and your DNS servers. The port must be open to the IP addresses for your DNS servers so that public domain names can be resolved. This port is optional if you are not using DNS servers for domain name resolution. Allowed Domains For WorkSpaces Pools users to access WorkSpaces, you must allow various domains on the network from which users initiate access to the WorkSpaces. For more information, see IP address and port requirements for WorkSpaces Personal. Note that the page speciﬁes that it applies to WorkSpaces Personal but it also applies to WorkSpaces Pools. Note If your S3 bucket has a “.” character in the name, the domain used is https://s3.<aws- region>.amazonaws.com. If your S3 bucket does not have a “.” character in the name, the domain used is https://<bucket-name>.s3.<aws-region>.amazonaws.com. Create a WorkSpaces Pool Set up and create a pool from which user applications are launched and streamed. Create a WorkSpaces Pool 632 Amazon WorkSpaces Note Administration Guide You should create a directory before you create a WorkSpaces Pool. For more information, see Conﬁgure SAML 2.0 and create a WorkSpaces Pools 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, Pool. 3. Choose Create WorkSpaces Pools. 4. Under Onboarding (optional), you can choose Recommend
workspaces-ag-210	workspaces-ag.pdf	210	not have a “.” character in the name, the domain used is https://<bucket-name>.s3.<aws-region>.amazonaws.com. Create a WorkSpaces Pool Set up and create a pool from which user applications are launched and streamed. Create a WorkSpaces Pool 632 Amazon WorkSpaces Note Administration Guide You should create a directory before you create a WorkSpaces Pool. For more information, see Conﬁgure SAML 2.0 and create a WorkSpaces Pools 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, Pool. 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 WorkSpace you want to use. You can skip this step if you know that you want to use WorkSpaces Pools. 5. Under Conﬁgure WorkSpaces, enter the following details: • For Name, enter a unique name identiﬁer 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 oﬀered 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. • For Running mode, choose from the following to conﬁgure the pool’s immediate availability and how you pay for it: • AutoStop — Pools instances are billed an hourly usage fee, based on the bundle chosen, only for the instances that are connected to users. Instances within the pool that are not connected to users are billed a low stopped-instance hourly fee. When users initiate their session, they start streaming after a 1-2 minute wait. • AlwaysOn — All pools instances that are running are billed the applicable hourly usage fee, even when users aren't connected. This mode is best for users who don’t want to wait for their streaming to start. Create a WorkSpaces Pool 633 Amazon WorkSpaces Administration Guide • 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 ﬁve 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 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 notiﬁed before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval speciﬁed 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. Create a WorkSpaces Pool 634 Amazon WorkSpaces Administration Guide • For Scheduled capacity policies (optional), choose Add new schedule capacity. Indicate the start and end date and time for
workspaces-ag-211	workspaces-ag.pdf	211	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. Create a WorkSpaces Pool 634 Amazon WorkSpaces Administration Guide • 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. Note The size of your pool is limited by the minimum and maximum capacity that you speciﬁed. • Choose Add new scale out policies and enter the values for adding speciﬁed instances if the speciﬁed capacity utilization is less or more than the speciﬁed threshold value. • Choose Add new scale in policies and enter the values for removing speciﬁed instances if the speciﬁed capacity utilization is less or more than the speciﬁed 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 speciﬁc 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. Administer WorkSpaces Pools A WorkSpaces Pool consists of WorkSpaces that run the image that you specify. Contents • Running mode for WorkSpaces Pools • WorkSpaces Pools Bundles • Modify a pool • Delete a pool • Auto scaling for WorkSpaces Pools Administer WorkSpaces Pools 635 Amazon WorkSpaces Administration Guide Running mode for WorkSpaces Pools The running mode of a WorkSpaces Pool determines its immediate availability and how you pay for it. You can choose between the following running modes when you create a WorkSpaces Pool: • AutoStop — Instances of a WorkSpaces Pool are billed an hourly usage fee based on the bundle chosen, only for the instances that are connected to users. Instances within a WorkSpaces Pool that are not connected to users are billed a low stopped-instance hourly fee. When users initiate their session, they start streaming after 1-2 minutes. • AlwaysOn — Running instances of a WorkSpaces Pool are billed the applicable hourly usage fee, even when users aren't connected. This mode is best for users who don’t want to wait for their streaming to start. For more information, see WorkSpaces Pricing. Contents • Modify the running mode Modify the running mode You can switch between running modes when a WorkSpaces Pool is in stopped state. To modify the running mode of a WorkSpaces Pool 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces and Pools. Select the WorkSpaces Pool to modify and coﬁrm it’s in stopped state. Then, choose Actions and Modify running mode. 4. Select the new running mode, AlwaysOn or AutoStop, and then choose Save. To modify the running mode of a WorkSpaces Pool using the AWS CLI • Use the update-workspaces-pool command. Running mode 636 Amazon WorkSpaces Administration Guide WorkSpaces Pools Bundles A WorkSpace bundle is a combination of an operating system, and storage, compute, and software resources. When you launch a WorkSpace, you select the bundle that meets your needs. The default bundles available for WorkSpaces are called public bundles. For more information about the various public bundles available for WorkSpaces, see Amazon WorkSpaces Bundles. The following table provides information about the licensing, streaming protocols, and bundles that are supported by each OS. Operating System Licenses Streaming protocols Supported bundles Windows Server 2019 Included DCV Windows Server 2022 Included DCV Value, Standard, Performance, Power, PowerPro Standard, Performance, Power, PowerPro, Graphics.G4dn, GraphicsP ro.G4dn Note • Operating system versions that are no longer supported by the vender are not guaranteed to work and are not supported by AWS support. Modify a pool After creating a WorkSpaces Pool, you can modify the following: • Directory ID (if the WorkSpaces Pool is stopped) • Basic details • Bundle and hardware • Session disconnect settings • Capacity and scaling • Scaling activities Bundles 637 Administration Guide Amazon WorkSpaces • Tags To modify a WorkSpaces Pool 1. 2. In the navigation pane, choose WorkSpaces, Pools. Select the pool you want to modify. 3. Go to the section that you want to modify and choose Edit. 4. Make the modiﬁcations that
workspaces-ag-212	workspaces-ag.pdf	212	vender are not guaranteed to work and are not supported by AWS support. Modify a pool After creating a WorkSpaces Pool, you can modify the following: • Directory ID (if the WorkSpaces Pool is stopped) • Basic details • Bundle and hardware • Session disconnect settings • Capacity and scaling • Scaling activities Bundles 637 Administration Guide Amazon WorkSpaces • Tags To modify a WorkSpaces Pool 1. 2. In the navigation pane, choose WorkSpaces, Pools. Select the pool you want to modify. 3. Go to the section that you want to modify and choose Edit. 4. Make the modiﬁcations that you want to make and choose Save. Delete a pool You can delete pools to free up resources and to avoid unintended charges to your account. We recommend stopping any unused, running pools. To delete a pool 1. 2. In the navigation pane, choose WorkSpaces, Pools. Select the pool that you want to stop, and then choose Stop. It takes about 5 minutes to stop a pool. 3. When the status of the pool is Stopped, choose Delete. Auto scaling for WorkSpaces Pools Auto Scaling lets you change the size of your pools automatically to match the supply of available instances to user demand. The size of your pool determines the number of users who can stream concurrently. One instance is required for each user session. You can specify your pool capacity in terms of instances. Based on your pool conﬁgurations and auto scaling policies, the required number of instances will be made available. You can deﬁne scaling policies that adjust the size of your pool automatically based on a variety of utilization metrics, and optimize the number of available instances to match user demand. You can also choose to turn oﬀ automatic scaling and make the pool run at a ﬁxed size. Note • As you develop your plan for WorkSpaces Pools scaling, make sure that your network conﬁguration meets your requirements. Delete a pool 638 Amazon WorkSpaces Administration Guide • When you use scaling, you work with the Application Auto Scaling API. For Auto Scaling to work correctly with WorkSpaces Pools, Application Auto Scaling requires permission to describe and update your pools and describe your Amazon CloudWatch alarms, and permissions to modify your pool capacity on your behalf. The following topics provide information to help you understand and use Auto Scaling for WorkSpaces Pools. Contents • Scaling concepts • Managing pool scaling using the console • Managing pool scaling using the AWS CLI • Additional resources Scaling concepts WorkSpaces Pools scaling is provided by Application Auto Scaling. For more information, see the Application Auto Scaling API Reference. To use Auto Scaling with WorkSpaces Pools eﬀectively, you must understand the following terms and concepts. Minimum capacity/minimum user sessions for the pool The minimum number of instances. The number of instances can't be below this value, and scaling policies will not scale your pool below this value. For example, if you set the minimum capacity for a pool to 2, your pool will never have less than 2 instances. Maximum capacity/maximum user sessions for the pool The maximum number of instances. The number of instances can't be above this value, and scaling policies will not scale your pool above this value. For example, if you set the maximum capacity for a pool to 10, your pool will never have more than 10 instances. Desired user session capacity The total number of sessions that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state. Auto Scaling for WorkSpaces Pools 639 Amazon WorkSpaces Scaling policy action Administration Guide The action that scaling policies perform on your pool when the Scaling Policy Condition is met. You can choose an action based on % capacity or number of instance(s). For example, if Desired user session capacity is 4 and Scaling Policy Action is set to "Add 25% capacity", Desired user session capacity is increased by 25% to 5 when Scaling Policy Condition is met. Scaling policy condition The condition that triggers the action set in Scaling Policy Action. This condition includes a scaling policy metric, a comparison operator, and a threshold. For example, to scale a pool if the utilization of the pool is greater than 50%, your scaling policy condition should be "If Capacity Utilization > 50%". Scaling policy metric Your scaling policy is based on this metric. The following metrics are available for scaling policies: Capacity Utilization The percentage of instances in a pool that are being used. You can use this metric to scale your pool based on usage of the pool. For example, Scaling Policy Condition: "If Capacity Utilization < 25%" perform Scaling Policy Action: "Remove 25 % capacity". Available capacity The number of instances in your pool
workspaces-ag-213	workspaces-ag.pdf	213	example, to scale a pool if the utilization of the pool is greater than 50%, your scaling policy condition should be "If Capacity Utilization > 50%". Scaling policy metric Your scaling policy is based on this metric. The following metrics are available for scaling policies: Capacity Utilization The percentage of instances in a pool that are being used. You can use this metric to scale your pool based on usage of the pool. For example, Scaling Policy Condition: "If Capacity Utilization < 25%" perform Scaling Policy Action: "Remove 25 % capacity". Available capacity The number of instances in your pool that are available for users. You can use this metric to maintain a buﬀer in your capacity available for users to start streaming sessions. For example, Scaling Policy Condition: "If Available Capacity < 5" perform Scaling Policy Action: "Add 5 instance(s)". Insuﬃcient capacity error The number of session requests rejected due to lack of capacity. You can use this metric to provision new instances for users who can't start streaming sessions due to lack of capacity. For example, Scaling Policy Condition: "If Insuﬃcient Capacity Error > 0" perform Scaling Policy Action: "Add 1 instance(s)". Managing pool scaling using the console You can set up and manage scaling by using the WorkSpaces console in either of the following two ways: During pool creation, or any time, by using the Pools tab. After you create pools, go to the Auto Scaling for WorkSpaces Pools 640 Amazon WorkSpaces Administration Guide Scaling Policies tab to add new scaling policies for your pool. For more information, see Create a WorkSpaces Pool. For user environments that vary in number, deﬁne scaling policies to control how scaling responds to demand. If you expect a ﬁxed number of users or have other reasons for disabling scaling, you can set your pool with a ﬁxed number of instances for user sessions. To do this, set the minimum capacity to your desired number of instances. Adjust the maximum capacity to be at least the value of the minimum capacity. This avoids validation errors, but the maximum capacity will ultimately be ignored since the pool will not be scaled. Then, delete all scaling policies for that pool. To set a pool scaling policy using the console 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose Pools. Select the pool. 4. On that pool's page, scroll down to capacity and scaling. 5. Choose Edit. 6. Edit existing policies and set the desired values in their ﬁeld and choose Save. The policy changes go into eﬀect within a few minutes. 7. You can also add new capacity and scaling policies by choosing Add new schedule capacity, Add new scale out policy, or Add new scale in policy. The following is an example usage graph of scaling activity when ﬁve users connect to the pool and then disconnect. This example is from a pool using the following scaling policy values: • Minimum capacity = 10 • Maximum capacity = 50 • Scale out = If my pool Capacity Utilization is Greater than 75% then add 5 instances • Scale in = If my pool Capacity Utilization is Less than 25% then remove 6 instances Note During the session, 5 new instances will be launched during a scale out event. During a scale in event, 6 instances will be reclaimed, if there are enough instances without active user sessions, and the total number of instances does not drop below the minimum Auto Scaling for WorkSpaces Pools 641 Amazon WorkSpaces Administration Guide capacity of 10 instances. Instances with running user sessions will not be reclaimed. Only instances with no user sessions running will be reclaimed. Managing pool scaling using the AWS CLI You can set up and manage pool scaling by using the AWS Command Line Interface (AWS CLI). For more advanced features such as setting scale-in and scale-out cooldown times, use the AWS CLI. Before running scaling policy commands, you must register your pool as a scalable target. To do so, use the following register-scalable-target command: aws application-autoscaling register-scalable-target --service-namespace workspaces \ --resource-id workspacespool/PoolId \ --scalable-dimension workspaces:workspacespool:DesiredUserSessions \ --min-capacity 1 --max-capacity 5 Examples • Example 1: Applying a scaling policy based on capacity utilization • Example 2: Applying a scaling policy based on insuﬃcient capacity errors • Example 3: Applying a scaling policy based on low capacity utilization • Example 4: Change the pool capacity based on a schedule • Example 5: Applying a target tracking scaling policy Example 1: Applying a scaling policy based on capacity utilization This AWS CLI example sets up a scaling policy that scales out a pool by 25% if Utilization >= 75%. The following put-scaling-policy command deﬁnes a utilization-based scaling policy: aws application-autoscaling put-scaling-policy -- cli-input-json file://scale-out- utilization.json The contents of the ﬁle scale-out-utilization.json
workspaces-ag-214	workspaces-ag.pdf	214	based on capacity utilization • Example 2: Applying a scaling policy based on insuﬃcient capacity errors • Example 3: Applying a scaling policy based on low capacity utilization • Example 4: Change the pool capacity based on a schedule • Example 5: Applying a target tracking scaling policy Example 1: Applying a scaling policy based on capacity utilization This AWS CLI example sets up a scaling policy that scales out a pool by 25% if Utilization >= 75%. The following put-scaling-policy command deﬁnes a utilization-based scaling policy: aws application-autoscaling put-scaling-policy -- cli-input-json file://scale-out- utilization.json The contents of the ﬁle scale-out-utilization.json are as follows: { "PolicyName": "policyname", "ServiceNamespace": "workspaces", Auto Scaling for WorkSpaces Pools 642 Amazon WorkSpaces Administration Guide "ResourceId": "workspacespool/PoolId", "ScalableDimension": "workspaces:workspacespool:DesiredUserSessions", "PolicyType": "StepScaling", "StepScalingPolicyConfiguration": { "AdjustmentType": "PercentChangeInCapacity", "StepAdjustments": [ { "MetricIntervalLowerBound": 0, "ScalingAdjustment": 25 } ], "Cooldown": 120 } } If the command is successful, the output is similar to the following, although some details are unique to your account and Region. In this example, the policy identiﬁer is e3425d21-16f0- d701-89fb-12f98dac64af. {"PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:e3425d21-16f0- d701-89fb-12f98dac64af:resource/workspaces/workspacespool/PoolId:policyName/scale-out- utilization-policy"} Now, set up a CloudWatch alarm for this policy. Use the names, Region, account number, and policy identiﬁer that apply to you. You can use the policy ARN returned by the previous command for the -- alarm-actions parameter. aws cloudwatch put-metric-alarm --alarm-name alarmname \ --alarm-description "Alarm when Available User Session Capacity exceeds 75 percent" \ --metric-name AvailableUserSessionCapacity \ --namespace AWS/WorkSpaces \ --statistic Average \ --period 300 \ --threshold 75 \ --comparison-operator GreaterThanOrEqualToThreshold \ --dimensions "Name=WorkSpaces pool ID,Value=PoolId" \ --evaluation-periods 1 --unit Percent \ --alarm-actions "arn:aws:autoscaling:your-region-code:account- number-without-hyphens:scalingPolicy:policyid:resource/workspaces/ workspacespool/PoolId:policyName/policyname" Auto Scaling for WorkSpaces Pools 643 Amazon WorkSpaces Administration Guide Example 2: Applying a scaling policy based on insuﬃcient capacity errors This AWS CLI example sets up a scaling policy that scales out the pool by 1 if the pool returns an InsufficientCapacityError error. The following command deﬁnes a insuﬃcient capacity-based scaling policy: aws application-autoscaling put-scaling-policy -- cli-input-json file://scale-out- capacity.json The contents of the ﬁle scale-out-capacity.json are as follows: { "PolicyName": "policyname", "ServiceNamespace": "workspaces", "ResourceId": "workspacespool/PoolId", "ScalableDimension": "workspaces:workspacespool:DesiredUserSessions", "PolicyType": "StepScaling", "StepScalingPolicyConfiguration": { "AdjustmentType": "ChangeInCapacity", "StepAdjustments": [ { "MetricIntervalLowerBound": 0, "ScalingAdjustment": 1 } ], "Cooldown": 120 } } If the command is successful, the output is similar to the following, although some details are unique to your account and Region. In this example, the policy identiﬁer is f4495f21-0650-470c-88e6-0f393adb64fc. {"PolicyARN": "arn:aws:autoscaling:us- west-2:123456789012:scalingPolicy:f4495f21-0650-470c-88e6-0f393adb64fc:resource/ workspaces/workspacespool/PoolId:policyName/scale-out-insufficient-capacity-policy"} Now, set up a CloudWatch alarm for this policy. Use the names, Region, account number, and policy identiﬁer that apply to you. You can use the policy ARN returned by the previous command for the --alarm-actions parameter. Auto Scaling for WorkSpaces Pools 644 Amazon WorkSpaces Administration Guide aws cloudwatch put-metric-alarm --alarm-name alarmname \ --alarm-description "Alarm when out of capacity is > 0" \ --metric-name InsufficientCapacityError \ --namespace AWS/WorkSpaces \ --statistic Maximum \ --period 300 \ --threshold 0 \ --comparison-operator GreaterThanThreshold \ --dimensions "Name=Pool,Value=PoolId" \ --evaluation-periods 1 --unit Count \ --alarm-actions "arn:aws:autoscaling:your-region-code:account- number-without-hyphens:scalingPolicy:policyid:resource/workspaces/ workspacespool/PoolId:policyName/policyname" Example 3: Applying a scaling policy based on low capacity utilization This AWS CLI example sets up a scaling policy that scales in the pool to reduce actual capacity when UserSessionsCapacityUtilization is low. The following command deﬁnes an excess capacity-based scaling policy: aws application-autoscaling put-scaling-policy -- cli-input-json file://scale-in- capacity.json The contents of the ﬁle scale-in-capacity.json are as follows: { "PolicyName": "policyname", "ServiceNamespace": "workspaces", "ResourceId": "workspacespool/PoolId", "ScalableDimension": "workspaces:workspacespool:DesiredUserSessions", "PolicyType": "StepScaling", "StepScalingPolicyConfiguration": { "AdjustmentType": "PercentChangeInCapacity", "StepAdjustments": [ { "MetricIntervalUpperBound": 0, "ScalingAdjustment": -25 } ], "Cooldown": 360 Auto Scaling for WorkSpaces Pools 645 Amazon WorkSpaces } } Administration Guide If the command is successful, the output is similar to the following, although some details are unique to your account and Region. In this example, the policy identiﬁer is 12ab3c4d-56789-0ef1-2345-6ghi7jk8lm90. {"PolicyARN": "arn:aws:autoscaling:us- west-2:123456789012:scalingPolicy:12ab3c4d-56789-0ef1-2345-6ghi7jk8lm90:resource/ workspaces/workspacespool/PoolId:policyName/scale-in-utilization-policy"} Now, set up a CloudWatch alarm for this policy. Use the names, Region, account number, and policy identiﬁer that apply to you. You can use the policy ARN returned by the previous command for the --alarm-actions parameter. aws cloudwatch put-metric-alarm --alarm-name alarmname \ --alarm-description "Alarm when Capacity Utilization is less than or equal to 25 percent" \ --metric-name UserSessionsCapacityUtilization \ --namespace AWS/WorkSpaces \ --statistic Average \ --period 120 \ --threshold 25 \ --comparison-operator LessThanOrEqualToThreshold \ --dimensions "Name=Pool,Value=PoolId" \ --evaluation-periods 10 --unit Percent \ --alarm-actions "arn:aws:autoscaling:your-region-code:account- number-without-hyphens:scalingPolicy:policyid:resource/workspaces/ workspacespool/PoolId:policyName/policyname" Example 4: Change the pool capacity based on a schedule Changing your pool capacity based on a schedule lets you scale your pool capacity in response to predictable changes in demand. For example, at the start of a work day, you might expect a certain number of users to request streaming connections at one time. To change your pool capacity based on a schedule, you can use the Application Auto Scaling PutScheduledAction API action or the put- scheduled-action AWS CLI command. Before changing your pool capacity, you can list your current pool capacity by using the
workspaces-ag-215	workspaces-ag.pdf	215	--alarm-actions "arn:aws:autoscaling:your-region-code:account- number-without-hyphens:scalingPolicy:policyid:resource/workspaces/ workspacespool/PoolId:policyName/policyname" Example 4: Change the pool capacity based on a schedule Changing your pool capacity based on a schedule lets you scale your pool capacity in response to predictable changes in demand. For example, at the start of a work day, you might expect a certain number of users to request streaming connections at one time. To change your pool capacity based on a schedule, you can use the Application Auto Scaling PutScheduledAction API action or the put- scheduled-action AWS CLI command. Before changing your pool capacity, you can list your current pool capacity by using the WorkSpaces describe-workspaces-pools AWS CLI command. Auto Scaling for WorkSpaces Pools 646 Amazon WorkSpaces Administration Guide aws workspaces describe-workspaces-pools --name PoolId The current pool capacity will appear similar to the following output (shown in JSON format): { "CapacityStatus": { "AvailableUserSessions": 1, "DesiredUserSessions": 1, "ActualUserSessions": 1, "ActiveUserSessions": 0 }, } Then, use the put-scheduled-action command to create a scheduled action to change your pool capacity. For example, the following command changes the minimum capacity to 3 and the maximum capacity to 5 every day at 9:00 AM UTC. Note For cron expressions, specify when to perform the action in UTC. For more information, see Cron Expressions. aws application-autoscaling put-scheduled-action --service-namespace workspaces \ --resource-id workspacespool/PoolId \ --schedule="cron(0 9 * * ? )" \ --scalable-target-action MinCapacity=3,MaxCapacity=5 \ --scheduled-action-name ExampleScheduledAction \ --scalable-dimension workspaces:workspacespool:DesiredUserSessions To conﬁrm that the scheduled action to change your pool capacity was successfully created, run the describe-scheduled-actions command. aws application-autoscaling describe-scheduled-actions --service-namespace workspaces --resource-id workspacespool/PoolId If the scheduled action was successfully created, the output appears similar to the following. { "ScheduledActions": [ Auto Scaling for WorkSpaces Pools 647 Amazon WorkSpaces { Administration Guide "ScalableDimension": "workspaces:workspacespool:DesiredUserSessions", "Schedule": "cron(0 9 * ? *)", "ResourceId": "workspacespool/ExamplePool", "CreationTime": 1518651232.886, "ScheduledActionARN": "<arn>", "ScalableTargetAction": { "MinCapacity": 3, "MaxCapacity": 5 }, "ScheduledActionName": "ExampleScheduledAction", "ServiceNamespace": "workspaces" } ] } For more information, see Scheduled Scaling in the Application Auto Scaling User Guide. Example 5: Applying a target tracking scaling policy With target tracking scaling, you can specify a capacity utilization level for your pool. When you create a target tracking scaling policy, Application Auto Scaling automatically creates and manages CloudWatch alarms that trigger the scaling policy. The scaling policy adds or removes capacity as required to keep capacity utilization at, or close to, the speciﬁed target value. To ensure application availability, your pool scales out proportionally to the metric as fast as it can but scales in more gradually. The following put-scaling-policy command deﬁnes a target tracking scaling policy that attempts to maintain 75% capacity utilization for a WorkSpaces pool. aws application-autoscaling put-scaling-policy -- cli-input-json file://config.json The contents of the ﬁle config.json are as follows: { "PolicyName":"target-tracking-scaling-policy", "ServiceNamespace":"workspaces", "ResourceId":"workspacespool/PoolId", "ScalableDimension":"workspaces:workspacespool:DesiredUserSessions", "PolicyType":"TargetTrackingScaling", "TargetTrackingScalingPolicyConfiguration":{ Auto Scaling for WorkSpaces Pools 648 Amazon WorkSpaces "TargetValue":75.0, Administration Guide "PredefinedMetricSpecification":{ "PredefinedMetricType":"WorkSpacesAverageUserSessionsCapacityUtilization" }, "ScaleOutCooldown":300, "ScaleInCooldown":300 } } If the command is successful, the output is similar to the following, although some details are unique to your account and Region. In this example, the policy identiﬁer is 6d8972f3- efc8-437c-92d1-6270f29a66e7. { "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:6d8972f3- efc8-437c-92d1-6270f29a66e7:resource/workspaces/workspacespool/PoolId:policyName/ target-tracking-scaling-policy", "Alarms": [ { "AlarmARN": "arn:aws:cloudwatch:us- west-2:123456789012:alarm:TargetTracking-workspacespool/PoolId-AlarmHigh-d4f0770c- b46e-434a-a60f-3b36d653feca", "AlarmName": "TargetTracking-workspacespool/PoolId-AlarmHigh-d4f0770c- b46e-434a-a60f-3b36d653feca" }, { "AlarmARN": "arn:aws:cloudwatch:us- west-2:123456789012:alarm:TargetTracking-workspacespool/PoolId-AlarmLow-1b437334- d19b-4a63-a812-6c67aaf2910d", "AlarmName": "TargetTracking-workspacespool/PoolId-AlarmLow-1b437334- d19b-4a63-a812-6c67aaf2910d" } ] } For more information, see Target Tracking Scaling Policies in the Application Auto Scaling User Guide. Additional resources To learn more about using the Application Auto Scaling AWS CLI commands or API actions, see the following resources: Auto Scaling for WorkSpaces Pools 649 Amazon WorkSpaces Administration Guide • application-autoscaling section of the AWS CLI Command Reference • Application Auto Scaling API Reference • Application Auto Scaling User Guide Using Active Directory with WorkSpaces Pools You can join your Windows WorkSpaces in WorkSpaces Pools to domains in Microsoft Active Directory and use your existing Active Directory domains, either cloud-based or on-premises, to launch domain-joined streaming instances. You can also use AWS Directory Service for Microsoft Active Directory, also known as AWS Managed Microsoft AD, to create an Active Directory domain and use that to support your WorkSpaces Pools resources. For more information about using AWS Managed Microsoft AD, see Microsoft Active Directory in the AWS Directory Service Administration Guide. By joining WorkSpaces Pools to your Active Directory domain, you can: • Allow your users and applications to access Active Directory resources such as printers and ﬁle shares from streaming sessions. • Use Group Policy settings that are available in the Group Policy Management Console (GPMC) to deﬁne the end user experience. • Stream applications that require users to be authenticated using their Active Directory login credentials. • Apply your enterprise compliance and security policies to your WorkSpaces in WorkSpaces Pools. Contents • Overview of Active Directory Domains • Before You Begin Using Active Directory with WorkSpaces Pools • Certiﬁcate-Based Authentication • WorkSpaces Pools Active Directory Administration • More Info Using Active Directory 650
workspaces-ag-216	workspaces-ag.pdf	216	users and applications to access Active Directory resources such as printers and ﬁle shares from streaming sessions. • Use Group Policy settings that are available in the Group Policy Management Console (GPMC) to deﬁne the end user experience. • Stream applications that require users to be authenticated using their Active Directory login credentials. • Apply your enterprise compliance and security policies to your WorkSpaces in WorkSpaces Pools. Contents • Overview of Active Directory Domains • Before You Begin Using Active Directory with WorkSpaces Pools • Certiﬁcate-Based Authentication • WorkSpaces Pools Active Directory Administration • More Info Using Active Directory 650 Amazon WorkSpaces Administration Guide Overview of Active Directory Domains Using Active Directory domains with WorkSpaces Pools requires an understanding of how they work together and the conﬁguration tasks that you'll need to complete. You'll need to complete the following tasks: 1. Conﬁgure Group Policy settings as needed to deﬁne the end user experience and security requirements for applications. 2. Create the domain-joined directory in WorkSpaces Pools. 3. Create the WorkSpaces Pools application in the SAML 2.0 identity provider and assign it to end users either directly or through Active Directory groups. User Authentication Flow 1. The user browses to https://applications.exampleco.com. The sign-on page requests authentication for the user. 2. The federation service requests authentication from the organization's identity store. 3. The identity store authenticates the user and returns the authentication response to the federation service. 4. On successful authentication, the federation service posts the SAML assertion to the user's browser. 5. The user's browser posts the SAML assertion to the AWS Sign-In SAML endpoint (https:// signin.aws.amazon.com/saml). AWS Sign-In receives the SAML request, processes the request, authenticates the user, and forwards the authentication token to the WorkSpaces Pools service. 6. Using the authentication token from AWS, WorkSpaces Pools authorizes the user and presents applications to the browser. 7. The user chooses an application and, depending on the Windows login authentication method that is enabled on the WorkSpaces Pools directory, they're prompted to enter their Active Directory domain password or choose a smart card. If both authentication methods are enabled, the user can choose whether to enter their domain password or use their smart card. Certiﬁcate- based authentication can also be used to authenticate users, removing the prompt. 8. The domain controller is contacted for user authentication. 9. After being authenticated with the domain, the user's session starts with domain connectivity. Active Directory Domains 651 Amazon WorkSpaces Administration Guide From the user's perspective, this process is transparent. The user starts by navigating to your organization's internal portal and is redirected to a WorkSpaces Pools portal, without having to enter AWS credentials. Only an Active Directory domain password or smart card credentials are required. Before a user can initiate this process, you must conﬁgure Active Directory with the required entitlements and Group Policy settings and create a domain-joined WorkSpaces Pools directory. Before You Begin Using Active Directory with WorkSpaces Pools Before you use Microsoft Active Directory domains with WorkSpaces Pools, be aware of the following requirements and considerations. Contents • Active Directory Domain Environment • Domain-Joined WorkSpaces in WorkSpaces Pools • Group Policy Settings • Smart Card Authentication Active Directory Domain Environment • You must have a Microsoft Active Directory domain to which to join your WorkSpaces. If you don't have an Active Directory domain or you want to use your on-premises Active Directory environment, see Active Directory Domain Services on the AWS Cloud: Quick Start Reference Deployment. • You must have a domain service account with permissions to create and manage computer objects in the domain that you intend to use with WorkSpaces Pools. For information, see How to Create a Domain Account in Active Directory in the Microsoft documentation. When you associate this Active Directory domain with WorkSpaces Pools, provide the service account name and password. WorkSpaces Pools uses this account to create and manage computer objects in the directory. For more information, see Granting Permissions to Create and Manage Active Directory Computer Objects. • When you register your Active Directory domain with WorkSpaces Pools, you must provide an organizational unit (OU) distinguished name. Create an OU for this purpose. The default Computers container is not an OU and cannot be used by WorkSpaces Pools. For more information, see Finding the Organizational Unit Distinguished Name. Before You Begin 652 Amazon WorkSpaces Administration Guide • The directories that you plan to use with WorkSpaces Pools must be accessible through their fully qualiﬁed domain names (FQDNs) through the virtual private cloud (VPC) in which your WorkSpaces are launched. For more information, see Active Directory and Active Directory Domain Services Port Requirements in the Microsoft documentation. Domain-Joined WorkSpaces in WorkSpaces Pools SAML 2.0-based user federation is required for application streaming from domain-joined WorkSpaces. Also, you must use a Windows image that supports joining to
workspaces-ag-217	workspaces-ag.pdf	217	used by WorkSpaces Pools. For more information, see Finding the Organizational Unit Distinguished Name. Before You Begin 652 Amazon WorkSpaces Administration Guide • The directories that you plan to use with WorkSpaces Pools must be accessible through their fully qualiﬁed domain names (FQDNs) through the virtual private cloud (VPC) in which your WorkSpaces are launched. For more information, see Active Directory and Active Directory Domain Services Port Requirements in the Microsoft documentation. Domain-Joined WorkSpaces in WorkSpaces Pools SAML 2.0-based user federation is required for application streaming from domain-joined WorkSpaces. Also, you must use a Windows image that supports joining to an Active Directory domain. All public images published on or after July 24, 2017 support joining an Active Directory domain. Group Policy Settings Verify your conﬁguration for the following Group Policy settings. If required, update the settings as described in this section so that they don't block WorkSpaces Pools from authenticating and logging in your domain users. Otherwise, when your users try to log in to WorkSpaces the login may not succeed. Instead, a message displays, notifying users that "An unknown error occurred." • Computer Conﬁguration > Administrative Templates > Windows Components > Windows Logon Options > Disable or Enable software Secure Attention Sequence — Set this to Enabled for Services. • Computer Conﬁguration > Administrative Templates > System > Logon > Exclude credential providers — Ensure that the following CLSID is not listed: e7c1bab5-4b49-4e64- a966-8d99686f8c7c • Computer Conﬁguration > Policies > Windows Settings > Security Settings > Local Policies > Security Options > Interactive Logon > Interactive Logon: Message text for users attempting to log on — Set this to Not deﬁned. • Computer Conﬁguration > Policies > Windows Settings > Security Settings > Local Policies > Security Options > Interactive Logon > Interactive Logon: Message title for users attempting to log on — Set this to Not deﬁned. Smart Card Authentication WorkSpaces Pools supports the use of Active Directory domain passwords or smart cards such as Common Access Card (CAC) and Personal Identity Veriﬁcation (PIV) smart cards for Windows sign in Before You Begin 653 Amazon WorkSpaces Administration Guide to WorkSpaces in WorkSpaces Pools. For information about how to conﬁgure your Active Directory environment to enable smart card sign in by using third-party certiﬁcation authorities (CAs), see Guidelines for enabling smart card logon with third-party certiﬁcation authorities in the Microsoft documentation. Certiﬁcate-Based Authentication You can use certiﬁcate-based authentication with WorkSpaces Pools joined to Microsoft Active Directory. This removes the user prompt for the Active Directory domain password when a user logs in. By using certiﬁcate-based authentication with your Active Directory domain, you can: • Rely on your SAML 2.0 identity provider to authenticate the user and provide SAML assertions to match the user in Active Directory. • Create a single sign-on logon experience with fewer user prompts. • Enable passwordless authentication ﬂows using your SAML 2.0 identity provider. Certiﬁcate-based authentication uses AWS Private Certiﬁcate Authority (AWS Private CA) resources in your AWS account. With AWS Private CA, you can create private certiﬁcate authority (CA) hierarchies, including root and subordinate CAs. You can also create your own CA hierarchy and issue certiﬁcates from it that authenticate internal users. For more information, see What is AWS Private CA. When you use AWS Private CA for certiﬁcate-based authentication, WorkSpaces Pools requests certiﬁcates for your users automatically at session reservation for each WorkSpace in a WorkSpaces Pool. It authenticates users to Active Directory with a virtual smart card provisioned with the certiﬁcates. Certiﬁcate-based authentication is supported on domain-joined WorkSpaces Pools that run Windows instances. Contents • Prerequisites • Enable Certiﬁcate-based Authentication • Manage Certiﬁcate-based Authentication • Enable Cross-account PCA Sharing Certiﬁcate-Based Authentication 654 Amazon WorkSpaces Prerequisites Administration Guide Complete the following steps before you use certiﬁcate-based authentication. 1. Conﬁgure your WorkSpaces Pools directory with SAML 2.0 integration to use certiﬁcate-based authentication. For more information, see Conﬁgure SAML 2.0 and create a WorkSpaces Pools directory. Note Don't enable Smart card sign in in your pool directory if you want to use certiﬁcate- based authentication. 2. Conﬁgure the userPrincipalName attribute in your SAML assertion. For more information, see Step 7: Create assertions for the SAML authentication response. 3. Conﬁgure the ObjectSid attribute in your SAML assertion. You can use this attribute to perform strong mapping with the Active Directory user. Certiﬁcate-based authentication fails if the ObjectSid attribute doesn't match the Active Directory security identiﬁer (SID) for the user speciﬁed in the SAML_Subject NameID. For more information, see Step 7: Create assertions for the SAML authentication response. Note According to Microsoft KB5014754, the ObjectSid attribute will become mandatory for certiﬁcate-based authentication after September 10, 2025. 4. Add the sts:TagSession permission to the IAM role trust policy that you use with your SAML 2.0 conﬁguration. For more information, see Passing session tags in AWS STS in
workspaces-ag-218	workspaces-ag.pdf	218	SAML assertion. You can use this attribute to perform strong mapping with the Active Directory user. Certiﬁcate-based authentication fails if the ObjectSid attribute doesn't match the Active Directory security identiﬁer (SID) for the user speciﬁed in the SAML_Subject NameID. For more information, see Step 7: Create assertions for the SAML authentication response. Note According to Microsoft KB5014754, the ObjectSid attribute will become mandatory for certiﬁcate-based authentication after September 10, 2025. 4. Add the sts:TagSession permission to the IAM role trust policy that you use with your SAML 2.0 conﬁguration. For more information, see Passing session tags in AWS STS in the AWS Identity and Access Management User Guide. This permission is required to use certiﬁcate-based authentication. For more information, see Step 5: Create a SAML 2.0 federation IAM role. 5. Create a private certiﬁcate authority (CA) using AWS Private CA, if you don't have one conﬁgured with your Active Directory. AWS Private CA is required to use certiﬁcate-based authentication. For more information, see Planning your AWS Private CA deployment in the AWS Private Certiﬁcate Authority User Guide. The following AWS Private CA settings are common for many certiﬁcate-based authentication use cases: • CA type options Certiﬁcate-Based Authentication 655 Amazon WorkSpaces Administration Guide • Short-lived certiﬁcate CA usage mode – Recommended if the CA only issues end user certiﬁcates for certiﬁcate-based authentication. • Single level hierarchy with a Root CA – Choose a subordinate CA to integrate it with an existing CA hierarchy. • Key algorithm options – RSA 2048 • Subject distinguished name options – Use the most appropriate options to identify this CA in your Active Directory Trusted Root Certiﬁcation Authorities store. • Certiﬁcate revocation options – CRL distribution Note Certiﬁcate-based authentication requires an online CRL distribution point accessible from both the WorkSpaces in WorkSpaces Pools and the domain controller. This requires unauthenticated access to the Amazon S3 bucket conﬁgured for AWS Private CA CRL entries, or a CloudFront distribution with access to the Amazon S3 bucket if it blocks public access. For more information about these options, see Planning a certiﬁcate revocation list (CRL) in the AWS Private Certiﬁcate Authority User Guide. 6. Tag your private CA with a key entitled euc-private-ca to designate the CA for use with WorkSpaces Pools certiﬁcate-based authentication. This key doesn't require a value. For more information, see Managing tags for your private CA in the AWS Private Certiﬁcate Authority User Guide.. 7. Certiﬁcate-based authentication uses virtual smart cards to log on. For more information, see Guidelines for enabling smart card logon with third-party certiﬁcation authorities. Follow these steps: a. Conﬁgure domain controllers with a domain controller certiﬁcate to authenticate smart card users. If you have an Active Directory Certiﬁcate Services enterprise CA conﬁgured in your Active Directory, it automatically enrolls domain controllers with certiﬁcates that enable smart card logon. If you don't have Active Directory Certiﬁcate Services, see Requirements for domain controller certiﬁcates from a third-party CA. You can create a domain controller certiﬁcate with AWS Private CA. If you do this, don't use a private CA conﬁgured for short- lived certiﬁcates. Certiﬁcate-Based Authentication 656 Amazon WorkSpaces Note Administration Guide If you use AWS Managed Microsoft AD, you can conﬁgure Certiﬁcate Services on an Amazon EC2 instance that satisﬁes the requirement for domain controller certiﬁcates. See Deploy Active Directory to a new Amazon Virtual Private Cloud for example deployments of AWS Managed Microsoft AD conﬁgured with Active Directory Certiﬁcate Services. With AWS Managed Microsoft AD and Active Directory Certiﬁcate Services, you must also create outbound rules from the controller's VPC security group to the Amazon EC2 instance running Certiﬁcate Services. You must provide the security group access to TCP port 135, and ports 49152 through 65535 to enable certiﬁcate auto- enrollment. The Amazon EC2 instance must also allow inbound access on these same ports from domain instances, including domain controllers. For more information on locating the security group for AWS Managed Microsoft AD, see Conﬁgure your VPC subnets and security groups. b. On the AWS Private CA console, or with the SDK or CLI, export the private CA certiﬁcate. For more information, see Exporting a private certiﬁcate. c. Publish the private CA to Active Directory. Log on to a domain controller or a domain-joined machine. Copy the private CA certiﬁcate to any <path>\<file> and run the following commands as a domain administrator. You can also use Group Policy and the Microsoft PKI Health Tool (PKIView) to publish the CA. For more information, see Conﬁguration instructions. certutil -dspublish -f <path>\<file> RootCA certutil -dspublish -f <path>\<file> NTAuthCA Make sure that the commands complete successfully, then remove the private CA certiﬁcate ﬁle. Depending on your Active Directory replication settings, it can take several minutes for the CA to publish to your domain controllers and WorkSpaces in WorkSpaces Pools. Certiﬁcate-Based Authentication 657 Amazon WorkSpaces Note Administration
workspaces-ag-219	workspaces-ag.pdf	219	a domain-joined machine. Copy the private CA certiﬁcate to any <path>\<file> and run the following commands as a domain administrator. You can also use Group Policy and the Microsoft PKI Health Tool (PKIView) to publish the CA. For more information, see Conﬁguration instructions. certutil -dspublish -f <path>\<file> RootCA certutil -dspublish -f <path>\<file> NTAuthCA Make sure that the commands complete successfully, then remove the private CA certiﬁcate ﬁle. Depending on your Active Directory replication settings, it can take several minutes for the CA to publish to your domain controllers and WorkSpaces in WorkSpaces Pools. Certiﬁcate-Based Authentication 657 Amazon WorkSpaces Note Administration Guide Active Directory must distribute the CA to the Trusted Root Certiﬁcation Authorities and Enterprise NTAuth stores automatically for WorkSpaces in WorkSpaces Pools when they join the domain. Note Active Directory domain controllers must be in Compatibility mode for certiﬁcate strong enforcement to support certiﬁcate-based authentication. For more information, see KB5014754—Certiﬁcate-based authentication changes on Windows domain controllers in the Microsoft Support documentation. If you are using AWS Managed Microsoft AD, see Conﬁgure directory security settings for more information. Enable Certiﬁcate-based Authentication Complete the following steps to enable certiﬁcate-based authentication. To enable certiﬁcate-based authentication 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Directories in the navigation pane. 3. Choose the Pools directories tab. 4. Choose the directory you want to conﬁgure. 5. Choose Edit in the Authentication section of the page. 6. Choose Edit Certiﬁcate-Based Authentication in the Certiﬁcate-Based Authentication section of the page. 7. Choose Enable Certiﬁcate-Based Authentication. 8. Choose the certiﬁcate in the AWS Certiﬁcate Manager (ACM) Private Certiﬁcate Authority (CA) drop-down. To appear in the drop-down, you should store the private CA in the same AWS account and AWS Region. You must also tag the private CA with a key named euc-private-ca. Certiﬁcate-Based Authentication 658 Amazon WorkSpaces Administration Guide 9. Conﬁgure directory log in fallback. With Fallback, users can log in with their AD domain password if certiﬁcate-based authentication is unsuccessful. This is recommended only in cases where users know their domain passwords. When fallback is turned oﬀ, a session can disconnect the user if a lock screen or Windows log oﬀ occurs. If fallback is turned on, the session prompts the user for their AD domain password. 10. Choose Save. Certiﬁcate-based authentication is now enabled. When users authenticate with SAML 2.0 to an WorkSpaces Pools directory using the domain-joined WorkSpaces, they will no longer receive a prompt for the domain password. Users will see a Connecting with certiﬁcate- based authentication message when connecting to a session enabled for certiﬁcate-based authentication. Manage Certiﬁcate-based Authentication After you enable certiﬁcate-based authentication, review the following tasks. Private CA Certiﬁcate In a typical conﬁguration, the private CA certiﬁcate has a validity period of 10 years. For more information about replacing a private CA with an expired certiﬁcate, or reissuing the private CA with a new validity period, see Managing the private CA lifecycle End User Certiﬁcates End user certiﬁcates issued by AWS Private Certiﬁcate Authority for WorkSpaces Pools certiﬁcate- based authentication don't require renewal or revocation. These certiﬁcates are short-lived. WorkSpaces Pools automatically issues a new certiﬁcate for each new session, or every 24 hours for sessions with a long duration. The WorkSpaces Pools session governs the use of these end user certiﬁcates. If you end a session, WorkSpaces Pools stops using that certiﬁcate. These end user certiﬁcates have a shorter validity period than a typical AWS Private Certiﬁcate Authority CRL distribution. As a result, end user certiﬁcates don't need to be revoked and won't appear in a CRL. Audit Reports You can create an audit report to list all of the certiﬁcates that your private CA has issued or revoked. For more information, see Using audit reports with your private CA. Certiﬁcate-Based Authentication 659 Amazon WorkSpaces Logging and Monitoring Administration Guide You can use CloudTrail to record API calls to a private CA by WorkSpaces Pools. For more information see What Is AWS CloudTrail? in the AWS CloudTrail User Guide, and Using CloudTrail in the AWS Private Certiﬁcate Authority User Guide. In CloudTrail Event history you can view GetCertiﬁcate and IssueCertiﬁcate event names from acm-pca.amazonaws.com event source made by the WorkSpaces Pools EcmAssumeRoleSession user name. These events will be recorded for every WorkSpaces Pools certiﬁcate-based authentication request. For more information, see Viewing events with CloudTrail Event history in the AWS CloudTrail User Guide. Enable Cross-account PCA Sharing Private CA (PCA) cross-account sharing oﬀers the ability to grant permissions for other accounts to use a centralized CA. The CA can generate and issue certiﬁcates by using AWS Resource Access Manager (RAM) to manage the permissions. This removes the need for a Private CA in every account. Private CA cross-account sharing can be used with AppStream 2.0 certiﬁcate-based Authentication (CBA) within the same AWS Region. To use a shared Private CA resource
workspaces-ag-220	workspaces-ag.pdf	220	for every WorkSpaces Pools certiﬁcate-based authentication request. For more information, see Viewing events with CloudTrail Event history in the AWS CloudTrail User Guide. Enable Cross-account PCA Sharing Private CA (PCA) cross-account sharing oﬀers the ability to grant permissions for other accounts to use a centralized CA. The CA can generate and issue certiﬁcates by using AWS Resource Access Manager (RAM) to manage the permissions. This removes the need for a Private CA in every account. Private CA cross-account sharing can be used with AppStream 2.0 certiﬁcate-based Authentication (CBA) within the same AWS Region. To use a shared Private CA resource with WorkSpaces Pools CBA, complete the following steps: 1. Conﬁgure the Private CA for CBA in a centralized AWS account. For more information, see the section called “Certiﬁcate-based authentication”. 2. Share the Private CA with the resource AWS accounts where WorkSpaces Pools resources utilize CBA. To do this, follow the steps in How to use AWS RAM to share your ACM Private CA cross- account. You do not need to complete step 3 to create a certiﬁcate. You can either share the Private CA with individual AWS accounts, or share through AWS Organizations. If you share with individual accounts, you need to accept the shared Private CA in your resource account by using the AWS Resource Access Manager console or APIs. When conﬁguring the share, conﬁrm that the AWS Resource Access Manager resource share for the Private CA in the resource account is using the AWSRAMBlankEndEntityCertificateAPICSRPassthroughIssuanceCertificateAuthority managed permission template. This template aligns with the PCA template used by the WorkSpaces Pools service role when issuing CBA certiﬁcates. 3. After the share is successful, view the shared Private CA by using the Private CA console in the resource account. Certiﬁcate-Based Authentication 660 Amazon WorkSpaces Administration Guide 4. Use the API or CLI to associate the Private CA ARN with CBA in your WorkSpaces Pools directory. At this time, the WorkSpaces Pools console does not support selection of shared Private CA ARNs. For more information, see the Amazon WorkSpaces Service API Reference. WorkSpaces Pools Active Directory Administration Setting up and using Active Directory with WorkSpaces Pools involves the following administrative tasks. Tasks • Granting Permissions to Create and Manage Active Directory Computer Objects • Finding the Organizational Unit Distinguished Name • Granting Local Administrator Rights on custom images • Locking the Streaming Session When the User is Idle • Conﬁguring WorkSpaces Pools to Use Domain Trusts Granting Permissions to Create and Manage Active Directory Computer Objects To allow WorkSpaces Pools to perform Active Directory computer object operations, you need an account with suﬃcient permissions. As a best practice, use an account that has only the minimum privileges necessary. The minimum Active Directory organizational unit (OU) permissions are as follows: • Create Computer Object • Change Password • Reset Password • Write Description Before setting up permissions, you'll need to do the following ﬁrst: • Obtain access to a computer or an EC2 instance that is joined to your domain. • Install the Active Directory User and Computers MMC snap-in. For more information, see Installing or Removing Remote Server Administration Tools for Windows 7 in the Microsoft documentation. • Log in as a domain user with appropriate permissions to modify the OU security settings. Administration 661 Amazon WorkSpaces Administration Guide • Create or identify the user, service account, or group for which to delegate permissions. To set up minimum permissions 1. Open Active Directory Users and Computers in your domain or on your domain controller. 2. In the left navigation pane, select the ﬁrst OU on which to provide domain join privileges, open the context (right-click) menu , and then choose Delegate Control. 3. On the Delegation of Control Wizard page, choose Next, Add. 4. For Select Users, Computers, or Groups, select the pre-created user, service account, or group, and then choose OK. 5. On the Tasks to Delegate page, choose Create a custom task to delegate, and then choose Next. 6. Choose Only the following objects in the folder, Computer objects. 7. Choose Create selected objects in this folder, Next. 8. For Permissions, choose Read, Write, Change Password, Reset Password, Next. 9. On the Completing the Delegation of Control Wizard page, verify the information and choose Finish. 10. Repeat steps 2-9 for any additional OUs that require these permissions. If you delegated permissions to a group, create a user or service account with a strong password and add that account to the group. This account will then have suﬃcient privileges to connect your WorkSpaces to the directory. Use this account when creating your WorkSpaces Pools directory conﬁguration. Finding the Organizational Unit Distinguished Name When you register your Active Directory domain with WorkSpaces Pools, you must provide an organizational unit (OU) distinguished name. Create an OU for this purpose. The default Computers container
workspaces-ag-221	workspaces-ag.pdf	221	the information and choose Finish. 10. Repeat steps 2-9 for any additional OUs that require these permissions. If you delegated permissions to a group, create a user or service account with a strong password and add that account to the group. This account will then have suﬃcient privileges to connect your WorkSpaces to the directory. Use this account when creating your WorkSpaces Pools directory conﬁguration. Finding the Organizational Unit Distinguished Name When you register your Active Directory domain with WorkSpaces Pools, you must provide an organizational unit (OU) distinguished name. Create an OU for this purpose. The default Computers container is not an OU and cannot be used by WorkSpaces Pools. The following procedure shows how to obtain this name. Note The distinguished name must start with OU= or it cannot be used for computer objects. Administration 662 Amazon WorkSpaces Administration Guide Before you complete this procedure, you'll need to do the following ﬁrst: • Obtain access to a computer or an EC2 instance that is joined to your domain. • Install the Active Directory User and Computers MMC snap-in. For more information, see Installing or Removing Remote Server Administration Tools for Windows 7 in the Microsoft documentation. • Log in as a domain user with appropriate permissions to read the OU security properties. To ﬁnd the distinguished name of an OU 1. Open Active Directory Users and Computers in your domain or on your domain controller. 2. Under View, ensure that Advanced Features is enabled. 3. In the left navigation pane, select the ﬁrst OU to use for WorkSpaces computer objects, open the context (right-click) menu, and then choose Properties. 4. Choose Attribute Editor. 5. Under Attributes, for distinguishedName, choose View. 6. For Value, select the distinguished name, open the context menu, and then choose Copy. Granting Local Administrator Rights on custom images By default, Active Directory domain users do not have local administrator rights on images. You can grant these rights by using Group Policy preferences in your directory, or manually, by using the local administrator account on an image. Granting local administrator rights to a domain user allows that user to install applications on and create custom images in WorkSpaces Pools. Contents • Using Group Policy preferences • Using the local Administrators group on the WorkSpace to create images Using Group Policy preferences You can use Group Policy preferences to grant local administrator rights to Active Directory users or groups and to all computer objects in the speciﬁed OU. The Active Directory users or groups to which you want to grant local administrator permissions must already exist. To use Group Policy preferences, you'll need to do the following ﬁrst: Administration 663 Amazon WorkSpaces Administration Guide • Obtain access to a computer or an EC2 instance that is joined to your domain. • Install the Group Policy Management Console (GPMC) MMC snap-in. For more information, see Installing or Removing Remote Server Administration Tools for Windows 7 in the Microsoft documentation. • Log in as a domain user with permissions to create Group Policy objects (GPOs). Link GPOs to the appropriate OUs. To use Group Policy preferences to grant local administrator permissions 1. In your directory or on a domain controller, open the command prompt as an administrator, type gpmc.msc, and then press ENTER. 2. In the left console tree, select the OU where you will create a new GPO or use an existing GPO, and then do either of the following: • Create a new GPO by opening the context (right-click) menu and choosing Create a GPO in this domain, Link it here. For Name, provide a descriptive name for this GPO. • Select an existing GPO. 3. Open the context menu for the GPO, and choose Edit. 4. 5. 6. 7. In the console tree, choose Computer Conﬁguration, Preferences, Windows Settings, Control Panel Settings, and Local Users and Groups. Select Local Users and Groups selected, open the context menu , and choose New, Local Group. For Action, choose Update. For Group name, choose Administrators (built-in). 8. Under Members, choose Add… and specify the Active Directory users or groups to which to assign local administrator rights on the streaming instance. For Action, choose Add to this group, and choose OK. 9. To apply this GPO to other OUs, select the additional OU, open the context menu and choose Link an Existing GPO. 10. Using the new or existing GPO name that you speciﬁed in step 2, scroll to ﬁnd the GPO, and then choose OK. 11. Repeat steps 9 and 10 for additional OUs that should have this preference. 12. Choose OK to close the New Local Group Properties dialog box. Administration 664 Amazon WorkSpaces Administration Guide 13. Choose OK again to close the GPMC. To apply the new preference to the GPO, you must stop and restart
workspaces-ag-222	workspaces-ag.pdf	222	choose OK. 9. To apply this GPO to other OUs, select the additional OU, open the context menu and choose Link an Existing GPO. 10. Using the new or existing GPO name that you speciﬁed in step 2, scroll to ﬁnd the GPO, and then choose OK. 11. Repeat steps 9 and 10 for additional OUs that should have this preference. 12. Choose OK to close the New Local Group Properties dialog box. Administration 664 Amazon WorkSpaces Administration Guide 13. Choose OK again to close the GPMC. To apply the new preference to the GPO, you must stop and restart any running image builders or ﬂeets. The Active Directory users and groups that you speciﬁed in step 8 are automatically granted local administrator rights on the image builders and ﬂeets in the OU to which the GPO is linked. Using the local Administrators group on the WorkSpace to create images To grant Active Directory users or groups local administrator rights on an image, you can manually add these users or groups to the local Administrators group on the image. The Active Directory users or groups to which to grant local administrator rights must already exist. 1. Connect to the WorkSpace you use to build images. The WorkSpace must be running and domain-joined. 2. Choose Start, Administrative Tools, and then double-click Computer Management. 3. In the left navigation pane, choose Local Users and Groups and open the Groups folder. 4. Open the Administrators group and choose Add.... 5. Select all Active Directory users or groups to which to assign local administrator rights and choose OK. Choose OK again to close the Administrator Properties dialog box. 6. Close Computer Management. 7. To log in as an Active Directory user and test whether that user has local administrator rights on the WorkSpaces, choose Admin Commands, Switch user, and then enter the credentials of the relevant user. Locking the Streaming Session When the User is Idle WorkSpaces Pools relies on a setting that you conﬁgure in the GPMC to lock the streaming session after your user is idle for speciﬁed amount of time. To use the GPMC, you'll need to do the following ﬁrst: • Obtain access to a computer or an EC2 instance that is joined to your domain. • Install the GPMC. For more information, see Installing or Removing Remote Server Administration Tools for Windows 7 in the Microsoft documentation. • Log in as a domain user with permissions to create GPOs. Link GPOs to the appropriate OUs. Administration 665 Amazon WorkSpaces Administration Guide To automatically lock the streaming instance when your user is idle 1. In your directory or on a domain controller, open the command prompt as an administrator, type gpmc.msc, and then press ENTER. 2. In the left console tree, select the OU where you will create a new GPO or use an existing GPO, and then do either of the following: • Create a new GPO by opening the context (right-click) menu and choosing Create a GPO in this domain, Link it here. For Name, provide a descriptive name for this GPO. • Select an existing GPO. 3. Open the context menu for the GPO, and choose Edit. 4. Under User Conﬁguration, expand Policies, Administrative Templates, Control Panel, and then choose Personalization. 5. Double-click Enable screen saver. 6. In the Enable screen saver policy setting, choose Enabled. 7. Choose Apply, and then choose OK. 8. Double-click Force speciﬁc screen saver. 9. In the Force speciﬁc screen saver policy setting, choose Enabled. 10. Under Screen saver executable name, enter scrnsave.scr. When this setting is enabled, the system displays a black screen saver on the user's desktop. 11. Choose Apply, and then choose OK. 12. Double-click Password protect the screen saver. 13. In the Password protect the screen saver policy setting, choose Enabled. 14. Choose Apply, and then choose OK. 15. Double-click Screen saver timeout. 16. In the Screen saver timeout policy setting, choose Enabled. 17. For Seconds, specify the length of time that users must be idle before the screen saver is applied. To set the idle time to 10 minutes, specify 600 seconds. 18. Choose Apply, and then choose OK. 19. In the console tree, under User Conﬁguration, expand Policies, Administrative Templates, System, and then choose Ctrl+Alt+Del Options. 20. Double-click Remove Lock Computer. Administration 666 Amazon WorkSpaces Administration Guide 21. In the Remove Lock Computer policy setting, choose Disabled. 22. Choose Apply, and then choose OK. Conﬁguring WorkSpaces Pools to Use Domain Trusts WorkSpaces Pools supports Active Directory domain environments where network resources such as ﬁle servers, applications, and computer objects reside in one domain, and the user objects reside in another. The domain service account used for computer object operations does not need to be in the same domain as the WorkSpaces Pools computer objects. When creating
workspaces-ag-223	workspaces-ag.pdf	223	expand Policies, Administrative Templates, System, and then choose Ctrl+Alt+Del Options. 20. Double-click Remove Lock Computer. Administration 666 Amazon WorkSpaces Administration Guide 21. In the Remove Lock Computer policy setting, choose Disabled. 22. Choose Apply, and then choose OK. Conﬁguring WorkSpaces Pools to Use Domain Trusts WorkSpaces Pools supports Active Directory domain environments where network resources such as ﬁle servers, applications, and computer objects reside in one domain, and the user objects reside in another. The domain service account used for computer object operations does not need to be in the same domain as the WorkSpaces Pools computer objects. When creating the directory conﬁguration, specify a service account that has the appropriate permissions to manage computer objects in the Active Directory domain where the ﬁle servers, applications, computer objects and other network resources reside. Your end user Active Directory accounts must have the "Allowed to Authenticate" permissions for the following: • WorkSpaces Pools computer objects • Domain controllers for the domain For more information, see Granting Permissions to Create and Manage Active Directory Computer Objects. More Info For more information related to this topic, see the following resources: • Microsoft Active Directory—Information about using AWS Directory Service. Bundles and images for WorkSpaces Pools A WorkSpace bundle is a combination of an operating system, and storage, compute, and software resources. When you launch a WorkSpace, you select the bundle that meets your needs. The default bundles available for WorkSpaces are called public bundles. For more information about the various public bundles available for WorkSpaces, see Amazon WorkSpaces Bundles. If you've launched a Windows WorkSpace and have customized it, you can create a custom image from that WorkSpace for use with WorkSpaces Pool. Linux are not supported in WorkSpaces Pool. More Info 667 Amazon WorkSpaces Administration Guide A custom image contains only the OS, software, and settings for the WorkSpace. A custom bundle is a combination of both that custom image and the hardware from which a WorkSpace can be launched. After you create a custom image, you can build a custom bundle that combines the custom WorkSpace image and the underlying compute and storage conﬁguration that you select. You can then specify this custom bundle when you create new WorkSpaces Pools to ensure that the new WorkSpaces in the pool have the same consistent conﬁguration (hardware and software). If you need to perform software updates or to install additional software on your WorkSpaces, you can update your custom bundle and use it to rebuild your WorkSpaces. WorkSpaces Pools supports several diﬀerent operating systems (OS), streaming protocols, and bundles. The following table provides information about the licensing, streaming protocols, and bundles that are supported by each OS. Operating System Licenses Streaming protocols Supported bundles Lifecycle policy / retiremen t date Windows Server 2019 Included DCV Windows Server 2022 Included DCV Value, Standard, Performance, Power, PowerPro January 9, 2029 Standard, Performance, Power, PowerPro, Graphics.G4dn, October 14, 2031 GraphicsPro.G4dn Note • Operating system versions that are no longer supported by the vender are not guaranteed to work and are not supported by AWS support. Topics • Bundle options for WorkSpaces Pools • Create a custom image and bundle for WorkSpaces Pools Bundles and images 668 Amazon WorkSpaces Administration Guide • Manage custom images and bundles for WorkSpaces Pools • Use session scripts to manage your users' streaming experience Bundle options for WorkSpaces Pools Before selecting a bundle to use with WorkSpaces Pool, ensure the bundle you want to select is compatible with your WorkSpaces' protocol, operating system, network, and compute type. We recommend testing the performance of bundles you want to choose in a test environment by running and using applications that replicate your users' daily tasks. For more information about protocols, see Protocols for WorkSpaces Personal. For more information about networks, see Client network requirements for WorkSpaces Personal. The following public bundles can be used with WorkSpaces Pool. For information about bundles in WorkSpaces, see Amazon WorkSpaces Bundles. Value, Standard, Performance, Power, PowerPro Value bundle This bundle is well-suited for the following: • Basic text editing and data entry • Web browsing with light usage • Instant messaging This bundle is not recommended for word processing, audio and video conferencing, screen sharing, software development tool, business intelligence applications, and graphics applications. Standard bundle This bundle is well-suited for the following: • Basic text editing and data entry • Web browsing • Instant messaging • Email Bundles options 669 Amazon WorkSpaces Administration Guide This bundle is not recommended for audio and video conferencing, screen sharing, word processing, software development tool, business intelligence applications, and graphics applications Performance bundle This bundle is well-suited for the following: • Web browsing • Word processing • Instant messaging • Email • Spreadsheets • Audio processing • Courseware This bundle is not recommended for video conferencing, screen sharing, software development
workspaces-ag-224	workspaces-ag.pdf	224	tool, business intelligence applications, and graphics applications. Standard bundle This bundle is well-suited for the following: • Basic text editing and data entry • Web browsing • Instant messaging • Email Bundles options 669 Amazon WorkSpaces Administration Guide This bundle is not recommended for audio and video conferencing, screen sharing, word processing, software development tool, business intelligence applications, and graphics applications Performance bundle This bundle is well-suited for the following: • Web browsing • Word processing • Instant messaging • Email • Spreadsheets • Audio processing • Courseware This bundle is not recommended for video conferencing, screen sharing, software development tool, business intelligence applications, and graphics applications Power bundle This bundle is well-suited for the following: • Web browsing • Word processing • Email • Instant messaging • Spreadsheets • Audio processing • Software development (Integrated Development Environment (IDE)) • Entry to mid-level data processing • Audio and video conferencing This bundle is not recommended for screen sharing, software development tool, business intelligence applications, and graphics applications. Bundles options 670 Amazon WorkSpaces PowerPro bundle This bundle is well-suited for the following: Administration Guide • Web browsing • Word processing • Email • Instant messaging • Spreadsheets • Audio processing • Software development (Integrated Development Environment (IDE)) • Data warehousing • Business intelligence applications • Audio and video conferencing This bundle is not recommended for machine learning model training, and graphics applications Graphics.g4dn bundle This bundle oﬀers a high level of graphics performance, and moderate level of CPU performance and memory for your WorkSpaces and is well-suited for the following: • Web browsing • Word processing • Email • Spreadsheets • Instant messaging • Audio conferencing • Software development (Integrated Development Environment (IDE)) • Entry to mid-level data processing • Data warehousing • Business intelligence applications • Graphic design • CAD/CAM (computer-aided design/computer-aided manufacturing) Bundles options 671 Amazon WorkSpaces Administration Guide This bundle is not recommended for audio and video conferencing, 3D rendering, photo-realistic design, and machine learning model training GraphicsPro.g4dn bundle This bundle oﬀers a high level of graphics performance, CPU performance, and memory for your WorkSpaces and is well-suited for the following: • Web browsing • Word processing • Email • Spreadsheets • Instant messaging • Audio conferencing • Software development (Integrated Development Environment (IDE)) • Entry to mid-level data processing • Data warehousing • Business intelligence applications • Graphic design • CAD/CAM (computer-aided design/computer-aided manufacturing) • Video transcoding • 3D rendering • Photo-realistic design • Game streaming • ML (machine learning) model training and ML inference This bundle is not recommended for audio and video conferencing. Create a custom image and bundle for WorkSpaces Pools WorkSpaces Pool supports Windows images and bundles only. If you've launched a Windows or WorkSpace and have customized it, you can create a custom image and custom bundles from that WorkSpace. Create a custom image and bundle 672 Amazon WorkSpaces Administration Guide A custom image contains only the OS, software, and settings for the WorkSpace. A custom bundle is a combination of both that custom image and the hardware from which a WorkSpace can be launched. After you create a custom image, you can build a custom bundle that combines the custom image and the underlying compute and storage conﬁguration that you select. You can then specify this custom bundle when you launch new WorkSpaces to ensure that the new WorkSpaces have the same consistent conﬁguration (hardware and software). You can use the same custom image to create various custom bundles by selecting diﬀerent compute and storage options for each bundle. Important • Custom bundle storage volumes can't be smaller than image storage volumes. Custom bundles cost the same as the public bundles they are created from. For more information about pricing, see Amazon WorkSpaces Pricing. Contents • Requirements to create Windows custom images • Best practices • (Optional) Step 1: Specify a custom computer name format for your image • Step 2: Run the Image Checker • Step 3: Create a custom image and custom bundle • What's included with Windows WorkSpaces custom images Requirements to create Windows custom images Note Windows currently deﬁnes 1 GB as 1,073,741,824 bytes. You must ensure they have greater than 12,884,901,888 bytes (or 12 GiB) free on C drive and the user proﬁle is less than 10,737,418,240 bytes (or 10 GiB) to create an image of a WorkSpace. Create a custom image and bundle 673 Amazon WorkSpaces Administration Guide • The status of the WorkSpace must be Available and its modiﬁcation state must be None. • All applications and user proﬁles on WorkSpaces images must be compatible with Microsoft Sysprep. • All applications to include in the image must be installed on the C drive. • All application services running on the WorkSpace must use a local system account instead of domain user credentials. For example,
workspaces-ag-225	workspaces-ag.pdf	225	on C drive and the user proﬁle is less than 10,737,418,240 bytes (or 10 GiB) to create an image of a WorkSpace. Create a custom image and bundle 673 Amazon WorkSpaces Administration Guide • The status of the WorkSpace must be Available and its modiﬁcation state must be None. • All applications and user proﬁles on WorkSpaces images must be compatible with Microsoft Sysprep. • All applications to include in the image must be installed on the C drive. • All application services running on the WorkSpace must use a local system account instead of domain user credentials. For example, you cannot have a Microsoft SQL Server Express installation running with a domain user's credentials. • The WorkSpace must not be encrypted. Image creation from an encrypted WorkSpace is not currently supported. • The following components are required in an image. Without these components, the WorkSpaces that you launch from the image will not function correctly. For more information, see the section called “Required conﬁguration and service components”. • Windows PowerShell version 3.0 or later • Remote Desktop Services • AWS PV drivers • Windows Remote Management (WinRM) • Teradici PCoIP agents and drivers • STXHD agents and drivers • AWS and WorkSpaces certiﬁcates • Skylight agent • WorkSpaces Pools only supports a maximum bundle / image root volume size of 200 GB. When you create a Windows custom image, ensure it is under the root volume size of 200 GB. Best practices Before you create an image from a WorkSpace, do the following: • Use a separate VPC that is not connected to your production environment. • Deploy the WorkSpace in a private subnet and use a NAT instance for outbound traﬃc. • Use a small Simple AD directory. • Use the smallest volume size for the source WorkSpace, and then adjust the volume size as needed when creating the custom bundle. Create a custom image and bundle 674 Amazon WorkSpaces Administration Guide • Install all operating system updates (except Windows feature/version updates) and all application updates on the WorkSpace. • Delete cached data from the WorkSpace that shouldn't be included in the bundle (for example, browser history, cached ﬁles, and browser cookies). • Delete conﬁguration settings from the WorkSpace that shouldn't be included in the bundle (for example, email proﬁles). • Switch to dynamic IP address settings using DHCP. • Make sure that you haven't exceeded your quota for WorkSpace images allowed in a Region. By default, you're allowed 40 WorkSpace images per Region. If you've reached this quota, new attempts to create an image will fail. To request a quota increase, use the WorkSpaces Limits form. • Make sure that you aren't trying to create an image from an encrypted WorkSpace. Image creation from an encrypted WorkSpace is not currently supported. • If you're running any antivirus software on the WorkSpace, disable it while you're attempting to create an image. • If you have a ﬁrewall enabled on your WorkSpace, make sure that it isn't blocking any necessary ports. For more information, see IP address and port requirements for WorkSpaces Personal. • For Windows WorkSpaces, don't conﬁgure any Group Policy Objects (GPOs) before image creation. • For Windows WorkSpaces, do not customize the default user proﬁle (C:\Users\Default) before creating an image. We recommend making any customizations to the user proﬁle through GPOs, and applying them after image creation. GPOs can be easily modiﬁed or rolled back, and are therefore less prone to error than customizations made to the default user proﬁle. • Ensure you update networking dependency drivers like ENA, NVMe, and PV drivers on your WorkSpaces. You should do this at least once every 6 months. For more information, see Install or upgrade Elastic Network Adapter (ENA) driver , AWS NVMe drivers for Windows instances, and Upgrade PV drivers on Windows instances. • Ensure you update the EC2Conﬁg, EC2Launch, and EC2Launch V2 agents to the latest versions periodically. You should do this at least once every 6 months. For more information, see Update EC2Conﬁg and EC2Launch. Create a custom image and bundle 675 Amazon WorkSpaces Administration Guide (Optional) Step 1: Specify a custom computer name format for your image For the WorkSpaces launched from your custom images, you can specify a custom preﬁx for the computer name format instead of using the default computer name format. By default, the format of the computer name for Windows 10 WorkSpaces is DESKTOP-XXXXX and for Windows 11 WorkSpaces, WORKSPA-XXXXX. Complete the following procedure to specify a custom preﬁx. 1. On the WorkSpace that you're using to create your custom image, open C:\ProgramData \Amazon\EC2-Windows\Launch\Sysprep\Unattend.xml in Notepad or another text editor. For more information about working with the Unattend.xml ﬁle, see Answer ﬁles (unattend.xml) in the Microsoft documentation. To access the C: drive from the Windows File Explorer on your WorkSpace,
workspaces-ag-226	workspaces-ag.pdf	226	images, you can specify a custom preﬁx for the computer name format instead of using the default computer name format. By default, the format of the computer name for Windows 10 WorkSpaces is DESKTOP-XXXXX and for Windows 11 WorkSpaces, WORKSPA-XXXXX. Complete the following procedure to specify a custom preﬁx. 1. On the WorkSpace that you're using to create your custom image, open C:\ProgramData \Amazon\EC2-Windows\Launch\Sysprep\Unattend.xml in Notepad or another text editor. For more information about working with the Unattend.xml ﬁle, see Answer ﬁles (unattend.xml) in the Microsoft documentation. To access the C: drive from the Windows File Explorer on your WorkSpace, enter C:\ in the address bar. 2. 3. In the <settings pass="specialize"> section, make sure that <ComputerName> is set to an asterisk (*). If <ComputerName> is set to any other value, your custom computer name settings will be ignored. For more information about the <ComputerName> setting, see ComputerName in the Microsoft documentation. In the <settings pass="specialize"> section, set <RegisteredOrganization> and <RegisteredOwner> to your preferred values. During Sysprep, the values that you specify for <RegisteredOwner> and <RegisteredOrganization> are concatenated together, and the ﬁrst 7 characters of the combined string are used to create the computer name. For example, if you specify Amazon.com for <RegisteredOrganization> and EC2 for <RegisteredOwner>, the computer names for the WorkSpaces created from your custom bundle will start with EC2AMAZ-xxxxxxx. The <RegisteredOrganization> and <RegisteredOwner> values in the <settings pass="oobeSystem"> section are ignored by Sysprep. 4. Save your changes to the Unattend.xml ﬁle. Step 2: Run the Image Checker To conﬁrm that your Windows WorkSpace meets the requirements for image creation, we recommend running the Image Checker application. The Image Checker performs a series of tests Create a custom image and bundle 676 Amazon WorkSpaces Administration Guide on the WorkSpace that you want to use to create your image, and provides guidance on how to resolve any issues it ﬁnds. The Image Checker is available only for Windows WorkSpaces. Important • The WorkSpace must pass all of the tests run by the Image Checker before you can use it for image creation. • Before you run the Image Checker, verify that the latest Windows security and cumulative updates are installed on your WorkSpace. To get the Image Checker, do one of the following: • Reboot your WorkSpace. The Image Checker is downloaded automatically during the reboot and installed at C:\Program Files\Amazon\ImageChecker.exe. • Download the Amazon WorkSpaces Image Checker from https://tools.amazonworkspaces.com/ ImageChecker.zip and extract the ImageChecker.exe ﬁle. Copy this ﬁle to C:\Program Files\Amazon\. To run the Image Checker 1. Open the C:\Program Files\Amazon\ImageChecker.exe ﬁle. 2. In the Amazon WorkSpaces Image Checker dialog box, choose Run. 3. After each test is completed, you can view the status of the test. For any test with a status of FAILED, choose Info to display information about how to resolve the issue that caused the failure. For more information about how to resolve these issues, see Tips for resolving issues detected by the Image Checker. If any tests display a status of WARNING, choose the Fix All Warnings button. The tool generates an output log ﬁle in the same directory where the Image Checker is located. By default, this ﬁle is located at C:\Program Files\Amazon \ImageChecker_yyyyMMddhhmmss.log. Don't delete this log ﬁle. If an issue occurs, this log ﬁle might be helpful in troubleshooting. Create a custom image and bundle 677 Amazon WorkSpaces Administration Guide 4. If applicable, resolve any issues that cause test failures and warnings, and repeat the process of running the Image Checker until the WorkSpace passes all tests. All failures and warnings must be resolved before you can create an image. 5. After your WorkSpace passes all tests, you see a Validation Successful message. You are now ready to create a custom bundle. Tips for resolving issues detected by the Image Checker In addition to consulting the following tips for resolving issues that are detected by the Image Checker, be sure to review the Image Checker log ﬁle at C:\Program Files\Amazon \ImageChecker_yyyyMMddhhmmss.log. PowerShell version 3.0 or later must be installed Install the latest version of Microsoft Windows PowerShell. Important The PowerShell execution policy for a WorkSpace must be set to allow RemoteSigned scripts. To check the execution policy, run the Get-ExecutionPolicy PowerShell command. If the execution policy is not set to Unrestricted or RemoteSigned, run the Set- ExecutionPolicy –ExecutionPolicy RemoteSigned command to change the value of the execution policy. The RemoteSigned setting allows the execution of scripts on Amazon WorkSpaces, which is required to create an image. Only the C and D drives can be present Only the C and D drives can be present on a WorkSpace that's used for imaging. Remove all other drives, including virtual drives. No pending reboot due to Windows Updates can be detected • The Create Image process can't run until Windows is rebooted to
workspaces-ag-227	workspaces-ag.pdf	227	PowerShell command. If the execution policy is not set to Unrestricted or RemoteSigned, run the Set- ExecutionPolicy –ExecutionPolicy RemoteSigned command to change the value of the execution policy. The RemoteSigned setting allows the execution of scripts on Amazon WorkSpaces, which is required to create an image. Only the C and D drives can be present Only the C and D drives can be present on a WorkSpace that's used for imaging. Remove all other drives, including virtual drives. No pending reboot due to Windows Updates can be detected • The Create Image process can't run until Windows is rebooted to ﬁnish installing security or cumulative updates. Reboot Windows to apply these updates, and make sure that no other pending Windows security or cumulative updates need to be installed. • Image creation is not supported on Windows 10 systems that have been upgraded from one version of Windows 10 to a newer version of Windows 10 (a Windows feature/version upgrade). Create a custom image and bundle 678 Amazon WorkSpaces Administration Guide However, Windows cumulative or security updates are supported by the WorkSpaces image- creation process. The Sysprep ﬁle must exist and can't be blank If there are problems with your Sysprep ﬁle, contact the AWS Support Center to get your EC2Conﬁg or EC2Launch repaired. The user proﬁle size must be less than 10 GB For Windows 7 WorkSpaces, the user proﬁle (D:\Users\username) must be less than 10 GB total. Remove ﬁles as needed to reduce the size of the user proﬁle. Drive C must have enough free space For Windows 7 WorkSpaces, you must have at least 12 GB of free space on drive C. Remove ﬁles as needed to free up space on drive C. For Windows 10 WorkSpaces, ignore if you receive a FAILED message and the disk space is above 2GB. No services can be running under a domain account To run the Create Image process, no services on the WorkSpace can be running under a domain account. All services must be running under a local account. To run services under a local account 1. Open C:\Program Files\Amazon\ImageChecker_yyyyMMddhhmmss.log and ﬁnd the list of services that are running under a domain account. 2. In the Windows search box, enter services.msc to open the Windows Services Manager. 3. Under Log On As, look for the services that are running under domain accounts. (Services running as Local System, Local Service, or Network Service do not interfere with image creation.) 4. Select a service that is running under a domain account, and then choose Action, Properties. 5. Open the Log On tab. Under Log on as, choose Local System account. 6. Choose OK. Create a custom image and bundle 679 Amazon WorkSpaces Administration Guide The WorkSpace must be conﬁgured to use DHCP You must conﬁgure all network adapters on the WorkSpace to use DHCP instead of static IP addresses. To set all network adapters to use DHCP 1. In the Windows search box, enter control panel to open the Control Panel. 2. Choose Network and Internet. 3. Choose Network and Sharing Center. 4. Choose Change adapter settings, and select an adapter. 5. Choose Change settings of this connection. 6. On the Networking tab, select Internet Protocol Version 4 (TCP/IPv4), and then choose Properties. 7. In the Internet Protocol Version 4 (TCP/IPv4) Properties dialog box, select Obtain an IP address automatically. 8. Choose OK. 9. Repeat this process for all network adapters on the WorkSpace. Remote Desktop Services must be enabled The Create Image process requires Remote Desktop Services to be enabled. To enable Remote Desktop Services 1. 2. 3. In the Windows search box, enter services.msc to open the Windows Services Manager. In the Name column, ﬁnd Remote Desktop Services. Select Remote Desktop Services, and then choose Action, Properties. 4. On the General tab, for Startup type, choose Manual or Automatic. 5. Choose OK. A user proﬁle must exist The WorkSpace that you're using to create images must have a user proﬁle (D:\Users \username). If this test fails, contact the AWS Support Center for assistance. Create a custom image and bundle 680 Amazon WorkSpaces Administration Guide The environment variable path must be properly conﬁgured The environment variable path for the local machine is missing entries for System32 and for Windows PowerShell. These entries are required for Create Image to run. To conﬁgure your environment variable path 1. 2. 3. In the Windows search box, enter environment variables and then choose Edit the system environment variables. In the System Properties dialog box, open the Advanced tab, and choose Environment Variables. In the Environment Variables dialog box, under System variables, select the Path entry and then choose Edit. 4. Choose New, and add the following path: C:\Windows\System32 5. Choose New again, and add the following path: C:\Windows\System32\WindowsPowerShell\v1.0\ 6. Choose OK. 7. Restart the WorkSpace.
workspaces-ag-228	workspaces-ag.pdf	228	is missing entries for System32 and for Windows PowerShell. These entries are required for Create Image to run. To conﬁgure your environment variable path 1. 2. 3. In the Windows search box, enter environment variables and then choose Edit the system environment variables. In the System Properties dialog box, open the Advanced tab, and choose Environment Variables. In the Environment Variables dialog box, under System variables, select the Path entry and then choose Edit. 4. Choose New, and add the following path: C:\Windows\System32 5. Choose New again, and add the following path: C:\Windows\System32\WindowsPowerShell\v1.0\ 6. Choose OK. 7. Restart the WorkSpace. Tip The order in which items appear in the environment variable path matters. To determine the correct order, you might want to compare the environment variable path of your WorkSpace with one from a newly created WorkSpace or a new Windows instance. Windows Modules Installer must be enabled The Create Image process requires the Windows Modules Installer service to be enabled. To enable the Windows Modules Installer service 1. 2. In the Windows search box, enter services.msc to open the Windows Services Manager. In the Name column, ﬁnd Windows Modules Installer. Create a custom image and bundle 681 Amazon WorkSpaces Administration Guide 3. Select Windows Modules Installer, and then choose Action, Properties. 4. On the General tab, for Startup type, choose Manual or Automatic. 5. Choose OK. Amazon SSM Agent must be disabled The Create Image process requires the Amazon SSM Agent service to be disabled. To disable the Amazon SSM Agent service 1. 2. 3. In the Windows search box, enter services.msc to open the Windows Services Manager. In the Name column, ﬁnd Amazon SSM Agent. Select Amazon SSM Agent, and then choose Action, Properties. 4. On the General tab, for Startup type, choose Disabled. 5. Choose OK. SSL3 and TLS version 1.2 must be enabled To conﬁgure SSL/TLS for Windows, see How to Enable TLS 1.2 in the Microsoft Windows documentation. Only one user proﬁle can exist on the WorkSpace There can be only one WorkSpaces user proﬁle (D:\Users\username) on the WorkSpace that you're using to create images. Delete any user proﬁles that don't belong to the intended user of the WorkSpace. For image creation to work, your WorkSpace can have only three user proﬁles on it: • The user proﬁle of the intended user of the WorkSpace (D:\Users\username) • The default user proﬁle (also known as Default Proﬁle) • The Administrator user proﬁle If there are additional user proﬁles, you can delete them through the advanced system properties in the Windows Control Panel. Create a custom image and bundle 682 Amazon WorkSpaces To delete a user proﬁle Administration Guide 1. To access the advanced system properties, do one of the following: • Press the Windows key+Pause Break, and then choose Advanced system settings in the left pane of the Control Panel > System and Security > System dialog box. • In the Windows search box, enter control panel. In the Control Panel, choose System and Security, then choose System, and then choose Advanced system settings in the left pane of the Control Panel > System and Security > System dialog box. In the System Properties dialog box, on the Advanced tab, choose Settings under User Proﬁles. If any proﬁle is listed other than the Administrator proﬁle, the Default Proﬁle, and the proﬁle of the intended WorkSpaces user, select that additional proﬁle and choose Delete. 2. 3. 4. When asked if you want to delete the proﬁle, choose Yes. 5. If necessary, repeat Steps 3 and 4 to remove any other proﬁles that don't belong on the WorkSpace. 6. Choose OK twice and close the Control Panel. 7. Restart the WorkSpace. No AppX packages can be in a staged state One or more AppX packages are in a staged state. This might cause a Sysprep error during image creation. To remove all staged AppX packages 1. In the Windows search box, enter powershell. Choose Run as Administrator. 2. When asked "Do you want to allow this app to make changes to your device?", choose Yes. 3. In the Windows PowerShell window, enter the following commands to list all staged AppX packages, and press Enter after each one. $workSpaceUserName = $env:username $allAppxPackages = Get-AppxPackage -AllUsers $packages = $allAppxPackages \| Where-Object { ` Create a custom image and bundle 683 Amazon WorkSpaces Administration Guide (($_.PackageUserInformation -like "S-1-5-18" - and !($_.PackageUserInformation -like "$workSpaceUserName")) -and ` ($_.PackageUserInformation -like "Staged" -or $_.PackageUserInformation -like "Installed")) -or ` ((!($_.PackageUserInformation -like "S-1-5-18") - and $_.PackageUserInformation -like "$workSpaceUserName") -and ` $_.PackageUserInformation -like "Staged") } 4. Enter the following command to remove all staged AppX packages, and press Enter. $packages \| Remove-AppxPackage -ErrorAction SilentlyContinue 5. Run the Image Checker again. If this test still fails, enter the following commands to remove all AppX packages, and press Enter after
workspaces-ag-229	workspaces-ag.pdf	229	= $env:username $allAppxPackages = Get-AppxPackage -AllUsers $packages = $allAppxPackages \| Where-Object { ` Create a custom image and bundle 683 Amazon WorkSpaces Administration Guide (($_.PackageUserInformation -like "S-1-5-18" - and !($_.PackageUserInformation -like "$workSpaceUserName")) -and ` ($_.PackageUserInformation -like "Staged" -or $_.PackageUserInformation -like "Installed")) -or ` ((!($_.PackageUserInformation -like "S-1-5-18") - and $_.PackageUserInformation -like "$workSpaceUserName") -and ` $_.PackageUserInformation -like "Staged") } 4. Enter the following command to remove all staged AppX packages, and press Enter. $packages \| Remove-AppxPackage -ErrorAction SilentlyContinue 5. Run the Image Checker again. If this test still fails, enter the following commands to remove all AppX packages, and press Enter after each one. Get-AppxProvisionedPackage -Online \| Remove-AppxProvisionedPackage -Online - ErrorAction SilentlyContinue Get-AppxPackage -AllUsers \| Remove-AppxPackage -ErrorAction SilentlyContinue Windows must not have been upgraded from a previous version Image creation is not supported on Windows systems that have been upgraded from one version of Windows 10 to a newer version of Windows 10 (a Windows feature/version upgrade). To create images, use a WorkSpace that has not undergone a Windows feature/version upgrade. The Windows rearm count must not be 0 The rearm feature allows you to extend the activation period for the trial version of Windows. The Create Image process requires that the rearm count be a value other than 0. To check the Windows rearm count 1. On the Windows Start menu, choose Windows System, then choose Command Prompt. 2. In the Command Prompt window, enter the following command, and then press Enter. cscript C:\Windows\System32\slmgr.vbs /dlv Create a custom image and bundle 684 Amazon WorkSpaces Administration Guide To reset the rearm count to a value other than 0, see Sysprep (Generalize) a Windows installation in the Microsoft Windows documentation. Other troubleshooting tips If your WorkSpace passes all of the tests run by the Image Checker, but you are still unable to create an image from the WorkSpace, check for the following issues: • Make sure that the WorkSpace isn't assigned to a user within a Domain Guests group. To check if there are any domain accounts, run the following PowerShell command. Get-WmiObject -Class Win32_Service \| Where-Object { $_.StartName -like "* $env:USERDOMAIN*" } • Some Group Policy Objects (GPOs) restrict access to the RDP certiﬁcate thumbprint when it is requested by the EC2Conﬁg service or the EC2Launch scripts during Windows instance conﬁguration. Before you try to create an image, move the WorkSpace to a new organizational unit (OU) with blocked inheritance and no GPOs applied. • Make sure that the Windows Remote Management (WinRM) service is conﬁgured to start automatically. Do the following: 1. In the Windows search box, enter services.msc to open the Windows Services Manager. 2. In the Name column, ﬁnd Windows Remote Management (WS-Management). 3. Select Windows Remote Management (WS-Management), and then choose Action, Properties. 4. On the General tab, for Startup type, choose Automatic. 5. Choose OK. Step 3: Create a custom image and custom bundle After you have validated your WorkSpace image, complete the following procedure to create your custom image and custom bundle using the WorkSpaces console. To create an image programmatically, use the CreateWorkspaceImage API action. For more information, see CreateWorkspaceImage in the Amazon WorkSpaces API Reference. To create a bundle programmatically, use the CreateWorkspaceBundle API action. For more information, see CreateWorkspaceBundle in the Amazon WorkSpaces API Reference. Create a custom image and bundle 685 Amazon WorkSpaces Administration Guide To create a custom image and custom bundle using the WorkSpaces console 1. If you are still connected to the WorkSpace, disconnect by choosing Amazon WorkSpaces and Disconnect in the WorkSpaces client application. 2. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 3. 4. In the navigation pane, choose WorkSpaces. Select the WorkSpace to open its details page and choose Create image. If the status of the WorkSpace is Stopped, you must start it ﬁrst (choose Actions, Start WorkSpaces) before you can choose Actions, Create Image. 5. A message displays, prompting you to reboot (restart) your WorkSpace before continuing. Rebooting your WorkSpace updates your Amazon WorkSpaces software to the latest version. Reboot your WorkSpace by closing the message and following the steps in Reboot a WorkSpace in WorkSpaces Personal. When you're done, repeat Step 4 of this procedure, but this time choose Next when the reboot message appears. To create an image, the status of the WorkSpace must be Available and its modiﬁcation state must be None. Enter an image name and a description that will help you identify the image, and then choose Create Image. While the image is being created, the status of the WorkSpace is Suspended and the WorkSpace is unavailable. Don't use a dash (-) special character in the description. It will cause an error. In the navigation pane, choose Images. The image is complete when the status of the WorkSpace changes to Available (this can take up to 45 minutes). Select the image and
workspaces-ag-230	workspaces-ag.pdf	230	create an image, the status of the WorkSpace must be Available and its modiﬁcation state must be None. Enter an image name and a description that will help you identify the image, and then choose Create Image. While the image is being created, the status of the WorkSpace is Suspended and the WorkSpace is unavailable. Don't use a dash (-) special character in the description. It will cause an error. In the navigation pane, choose Images. The image is complete when the status of the WorkSpace changes to Available (this can take up to 45 minutes). Select the image and choose Actions, Create bundle. Enter a bundle name and a description, and then do the following: 6. 7. 8. 9. • For Bundle hardware type, choose the hardware to use when launching WorkSpaces from this custom bundle. • The default available size combinations for the root volume is 200 GB per WorkSpace. 10. To conﬁrm that your bundle has been created, choose Bundles and verify that the bundle is listed. What's included with Windows WorkSpaces custom images When you create an image from a Windows WorkSpace, the entire contents of the C drive are included. Create a custom image and bundle 686 Administration Guide Amazon WorkSpaces • Contacts • Downloads • Music • Pictures • Saved games • Videos • Podcasts • Virtual machines • .virtualbox • Tracing • appdata\local\temp • appdata\roaming\apple computer\mobilesync\ • appdata\roaming\apple computer\logs\ • appdata\roaming\apple computer\itunes\iphone software updates\ • appdata\roaming\macromedia\ﬂash player\macromedia.com\support\ﬂashplayer\sys\ • appdata\roaming\macromedia\ﬂash player\#sharedobjects\ • appdata\roaming\adobe\ﬂash player\assetcache\ • appdata\roaming\microsoft\windows\recent\ • appdata\roaming\microsoft\oﬃce\recent\ • appdata\roaming\microsoft oﬃce\live meeting • appdata\roaming\microsoft shared\livemeeting shared\ • appdata\roaming\mozilla\ﬁrefox\crash reports\ • appdata\roaming\mcafee\common framework\ • appdata\local\microsoft\feeds cache • appdata\local\microsoft\windows\temporary internet ﬁles\ • appdata\local\microsoft\windows\history\ • appdata\local\microsoft\internet explorer\domstore\ • appdata\local\microsoft\internet explorer\imagestore\ Create a custom image and bundle 687 Amazon WorkSpaces Administration Guide • appdata\locallow\microsoft\internet explorer\iconcache\ • appdata\locallow\microsoft\internet explorer\domstore\ • appdata\locallow\microsoft\internet explorer\imagestore\ • appdata\local\microsoft\internet explorer\recovery\ • appdata\local\mozilla\ﬁrefox\proﬁles\ Manage custom images and bundles for WorkSpaces Pools The process to manage custom images and bundles is the same between WorkSpaces Personal and WorkSpaces Pool. For more information about how to manage images and bundles, refer to the following documentation within the WorkSpaces Personal section of this guide: Note The primary diﬀerence between custom bundles that you can use for WorkSpaces Personal and ones that you can use for WorkSpaces Pool is the operating system and base public bundle that can be used. For the operating systems and bundles that are supported in WorkSpaces Pool, see A WorkSpace bundle is a combination of an operating system, and storage, compute, and software resources. When you launch a WorkSpace, you select the bundle that meets your needs. The default bundles available for WorkSpaces are called public bundles. For more information about the various public bundles available for WorkSpaces, see Amazon WorkSpaces Bundles. The following table provides information about the licensing, streaming protocols, and bundles that are supported by each OS. Windows Server 2019 Windows Server 2022 Included DCV Value, Standard, Performance, Power, PowerPro Included DCV Standard, Performance, Power, PowerPro, Graphics.G4dn, GraphicsPro.G4dn Operating System Licenses Streaming protocols Supported bundles Manage custom images and bundles 688 Amazon WorkSpaces Administration Guide Note • Operating system versions that are no longer supported by the vender are not guaranteed to work and are not supported by AWS support. . • Update a custom bundle for WorkSpaces Personal. • Copy a custom image in WorkSpaces Personal. • Share or unshare a custom image in WorkSpaces Personal. • Delete a custom bundle or image in WorkSpaces Personal. Use session scripts to manage your users' streaming experience WorkSpaces Pool provides on-instance session scripts. You can use these scripts to run your own custom scripts when speciﬁc events occur in users' streaming sessions. For example, you can use custom scripts to prepare your WorkSpaces Pools environment before your users' streaming sessions begin. You can also use custom scripts to clean up streaming instances after users complete their streaming sessions. Session scripts are speciﬁed within a WorkSpace image. These scripts are run within the user context or the system context. If your session scripts use the standard out to write information, error, or debugging messaging, these can be optionally saved to an Amazon S3 bucket within your Amazon Web Services account. Contents • Run Scripts Before Streaming Sessions Begin • Run Scripts After Streaming Sessions End • Create and Specify Session Scripts • Session Scripts Conﬁguration File • Using Windows PowerShell Files Use session scripts to manage experience 689 Amazon WorkSpaces Administration Guide • Logging Session Script Output • Use persistent storage with session scripts • Enable Amazon S3 Bucket Storage for Session Script Logs Run Scripts Before Streaming Sessions Begin You can conﬁgure your scripts to run for a maximum of 60 seconds before your users' applications launch and their streaming sessions begin. Doing so enables you to customize the WorkSpaces Pools environment
workspaces-ag-231	workspaces-ag.pdf	231	Scripts Before Streaming Sessions Begin • Run Scripts After Streaming Sessions End • Create and Specify Session Scripts • Session Scripts Conﬁguration File • Using Windows PowerShell Files Use session scripts to manage experience 689 Amazon WorkSpaces Administration Guide • Logging Session Script Output • Use persistent storage with session scripts • Enable Amazon S3 Bucket Storage for Session Script Logs Run Scripts Before Streaming Sessions Begin You can conﬁgure your scripts to run for a maximum of 60 seconds before your users' applications launch and their streaming sessions begin. Doing so enables you to customize the WorkSpaces Pools environment before users start streaming their applications. When the session scripts run, a loading spinner displays for your users. When your scripts complete successfully or the maximum waiting time elapses, your users' streaming session will begin. If your scripts don't complete successfully, an error message displays for your users. However, your users are not prevented from using their streaming session. When you specify a ﬁle name on a Windows instance, you must use a double backslash. For example: C:\\Scripts\\Myscript.bat If you don't use a double backslash, an error displays to notify you that the .json ﬁle is incorrectly formatted. Note When your scripts complete successfully, they must return a value of 0. If your scripts return a value other than 0, WorkSpaces displays the error message to the user. When you run scripts before streaming sessions begin, the following process occurs: 1. Your users connect to a WorkSpace in a WorkSpaces Pool that is not domain-joined. They connect by using SAML 2.0. 2. One of the following occurs: • If application settings persistence is enabled for your users, the application settings Virtual Hard Disk (VHD) ﬁle that stores your users' customizations and Windows settings is downloaded and mounted. Windows user login is required in this case. Use session scripts to manage experience 690 Amazon WorkSpaces Administration Guide For information about application settings persistence, see Enable application settings persistence for your WorkSpaces Pools users. • If application settings persistence is not enabled, the Windows user is already logged in. 3. Your session scripts start. If persistent storage is enabled for your users, storage connector mounting also starts. For information about persistent storage, see Enable and Administer Persistent Storage for WorkSpaces Pools. Note The storage connector mount doesn't need to complete for the streaming session to start. If the session scripts complete before the storage connector mount completes, the streaming session starts. For information about monitoring the mount status of storage connectors, see Use persistent storage with session scripts. 4. Your session scripts complete or time out. 5. The users' streaming session starts. Run Scripts After Streaming Sessions End You can also conﬁgure your scripts to run after users' streaming sessions end. For example, you can run a script when users select End Session from the WorkSpaces client toolbar, or when they reach the maximum allowed duration for the session. You can also use these session scripts to clean up your WorkSpaces environment before a streaming instance is terminated. For example, you can use scripts to release ﬁle locks or upload log ﬁles. When you run scripts after streaming sessions end, the following process occurs: 1. Your users' WorkSpaces streaming session ends. 2. Your session termination scripts start. 3. The session termination scripts complete or time out. 4. Windows user logout occurs. 5. One or both of the following occur in parallel, if applicable: • If application settings persistence is enabled for your users, the application settings VHD ﬁle that stores your users' customizations and Windows settings is unmounted and uploaded to an Amazon S3 bucket in your account. Use session scripts to manage experience 691 Amazon WorkSpaces Administration Guide • If persistent storage is enabled for your users, the storage connector completes a ﬁnal synchronization and is unmounted. 6. The WorkSpace is terminated. Create and Specify Session Scripts Complete the following procedure to create and specify session scripts for your WorkSpaces in a WorkSpaces Pool. 1. Connect to the Windows WorkSpaces from which you are creating a custom image. 2. Create the directory /AWSEUC/SessionScripts if it does not already exist. 3. Create a conﬁguration ﬁle /AWSEUC/SessionScripts/config.json if it does not already exist, using the Session Script Conﬁguration template. 4. Navigate to C:\AWSEUC\SessionScripts, and open the config.json conﬁguration ﬁle. For information about session script parameters, see Session Scripts Conﬁguration File. 5. After you ﬁnish making your changes, save and close the config.json ﬁle. 6. Complete the steps to create an image from the WorkSpace. For more information, see Create a custom image and bundle for WorkSpaces Pools. Session Scripts Conﬁguration File To locate the session scripts conﬁguration ﬁle in a Windows instance, navigate to C:\AWSEUC \SessionScripts\config.json. The ﬁle is formatted as follows. Note The conﬁguration ﬁle is in JSON format. Verify that any
workspaces-ag-232	workspaces-ag.pdf	232	using the Session Script Conﬁguration template. 4. Navigate to C:\AWSEUC\SessionScripts, and open the config.json conﬁguration ﬁle. For information about session script parameters, see Session Scripts Conﬁguration File. 5. After you ﬁnish making your changes, save and close the config.json ﬁle. 6. Complete the steps to create an image from the WorkSpace. For more information, see Create a custom image and bundle for WorkSpaces Pools. Session Scripts Conﬁguration File To locate the session scripts conﬁguration ﬁle in a Windows instance, navigate to C:\AWSEUC \SessionScripts\config.json. The ﬁle is formatted as follows. Note The conﬁguration ﬁle is in JSON format. Verify that any text you type in this ﬁle is in valid JSON format. { "SessionStart": { "executables": [ { "context": "system", Use session scripts to manage experience 692 Amazon WorkSpaces Administration Guide "filename": "", "arguments": "", "s3LogEnabled": true }, { "context": "user", "filename": "", "arguments": "", "s3LogEnabled": true } ], "waitingTime": 30 }, "SessionTermination": { "executables": [ { "context": "system", "filename": "", "arguments": "", "s3LogEnabled": true }, { "context": "user", "filename": "", "arguments": "", "s3LogEnabled": true } ], "waitingTime": 30 } } You can use the following parameters in the session scripts conﬁguration ﬁle. SessionStart/SessionTermination The session scripts to run in the appropriate session event based on the name of the object. Type: String Required: No Allowed values: SessionStart, SessionTermination Use session scripts to manage experience 693 Amazon WorkSpaces WaitingTime The maximum duration of the session scripts in seconds. Administration Guide Type: Integer Required: No Constraints: The maximum duration is 60 seconds. If the session scripts don't complete within this duration, they will be stopped. If you require a script to continue running, launch it as a separate process. Executables The details for the session scripts to run. Type: String Required: Yes Constraints: The maximum number of scripts that can run per session event is 2 (one for the user context, one for the system context). Context The context in which to run the session script. Type: String Required: Yes Allowed values: user, system Filename The full path to the session script to run. If this parameter is not speciﬁed, the session script is not run. Type: String Required: No Constraints: The maximum length for the ﬁle name and full path is 1,000 characters. Use session scripts to manage experience 694 Amazon WorkSpaces Administration Guide Allowed values: .bat, .exe, .sh Note You can also use Windows PowerShell ﬁles. For more information, see Using Windows PowerShell Files. Arguments The arguments for your session script or executable ﬁle. Type: String Required: No Length constraints: The maximum length is 1,000 characters. S3LogEnabled When the value for this parameter is set to True, an S3 bucket is created within your Amazon Web Services account to store the logs created by the session script. By default, this value is set to True. For more information, see the Logging Session Script Output section later in this topic. Type: Boolean Required: No Allowed values: True, False Using Windows PowerShell Files To use Windows PowerShell ﬁles, specify the full path to the PowerShell ﬁle in the filename parameter: "filename": "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe", Then specify your session script in the arguments parameter: Use session scripts to manage experience 695 Amazon WorkSpaces Administration Guide "arguments": "-File \"C:\\path\\to\\session\\script.ps1\"", Finally, verify that the PowerShell Execution Policy allows your PowerShell ﬁle to run. Logging Session Script Output When this option is enabled in the conﬁguration ﬁle, WorkSpaces Pool automatically captures the output from the session script that is written to the standard out. This output is uploaded to an Amazon S3 bucket in your account. You can review the log ﬁles for troubleshooting or debugging purposes. Note The log ﬁles are uploaded when the session script returns a value, or the value set in WaitingTime has elapsed, whichever comes ﬁrst. Use persistent storage with session scripts When WorkSpaces persistent storage is enabled, the storage begins mounting when the session start scripts run. If your script relies on persistent storage being mounted, you can wait for the connectors to be available. WorkSpaces maintains the mount status of the storage connectors in the Windows registry on Windows WorkSpaces, at the following key: HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\AWSEUC\Storage\<provided user name>\<Storage connector> The registry key values are as follows: • Provided user name — The user ID provided through the access mode. The access modes and value for each mode are as follows: • User Pool — The email address for the user • Streaming URL — The UserID • SAML — The NameID. If the user name includes a slash (for example, a domain user’s SAMAccountName), the slash is replaced by a "-" character. • Storage connector — The connector for the persistent storage option that is enabled for the user. The storage connector values are as follows: Use session scripts to manage experience 696 Amazon WorkSpaces • HomeFolder Administration Guide Each storage connector
workspaces-ag-233	workspaces-ag.pdf	233	user ID provided through the access mode. The access modes and value for each mode are as follows: • User Pool — The email address for the user • Streaming URL — The UserID • SAML — The NameID. If the user name includes a slash (for example, a domain user’s SAMAccountName), the slash is replaced by a "-" character. • Storage connector — The connector for the persistent storage option that is enabled for the user. The storage connector values are as follows: Use session scripts to manage experience 696 Amazon WorkSpaces • HomeFolder Administration Guide Each storage connector registry key contains a MountStatus DWORD value. The following table lists the possible values for MountStatus. Note To view these registry keys, you must have Microsoft .NET Framework version 4.7.2 or later installed on your image. Value Description 0 1 2 3 4 Storage connector not be enabled for this user Storage connector mounting is in progress Storage connector mounted successfully Storage connector mounting failed Storage connector mounting is enabled, but not mounted yet Enable Amazon S3 Bucket Storage for Session Script Logs When you enable Amazon S3 logging in your session script conﬁguration, WorkSpaces Pool captures standard output from your session script. The output is periodically uploaded to an S3 bucket within your Amazon Web Services account. For every AWS Region, WorkSpaces Pool creates a bucket in your account that is unique to your account and the Region. You do not need to perform any conﬁguration tasks to manage these S3 buckets. They are fully managed by the WorkSpaces service. The log ﬁles that are stored in each bucket are encrypted in transit using Amazon S3's SSL endpoints and at rest using Amazon S3-managed encryption keys. The buckets are named in a speciﬁc format as follows: wspool-logs-<region-code>-<account-id-without-hyphens>-random-identifier Use session scripts to manage experience 697 Amazon WorkSpaces <region-code> Administration Guide This is the AWS Region code in which the WorkSpaces Pool is created with Amazon S3 bucket storage enabled for session script logs. <account-id-without-hyphens> Your Amazon Web Services account identiﬁer. The random ID ensures that there is no conﬂict with other buckets in that Region. The ﬁrst part of the bucket name, wspool-logs, does not change across accounts or Regions. For example, if you specify session scripts in an image in the US West (Oregon) Region (us- west-2) on account number 123456789012, WorkSpaces Pool creates an Amazon S3 bucket within your account in that Region with the name shown. Only an administrator with suﬃcient permissions can delete this bucket. wspool-logs-us-west-2-1234567890123-abcdefg Disabling session scripts does not delete log ﬁles stored in the S3 bucket. To permanently delete log ﬁles, you or another administrator with adequate permissions must do so by using the Amazon S3 console or API. WorkSpaces Pools adds a bucket policy that prevents accidental deletion of the bucket. When session scripts are enabled, a unique folder is created for each streaming session that is started. The path for the folder where the log ﬁles are stored in the S3 bucket in your account uses the following structure: <bucket-name>/<stack-name>/<fleet-name>/<access-mode>/<user-id-SHA-256-hash>/<session- id>/SessionScriptsLogs/<session-event> <bucket-name> The name of the S3 bucket in which the session scripts are stored. The name format is described earlier in this section. <stack-name> The name of the stack the session came from. Use session scripts to manage experience 698 Amazon WorkSpaces <fleet-name> Administration Guide The name of the WorkSpaces Pool the session script is running on. <access-mode> The identity method of the user: custom for the WorkSpaces API or CLI, federated for SAML, and userpool for users in the user pool. <user-id-SHA-256-hash> The user-speciﬁc folder name. This name is created using a lowercase SHA-256 hash hexadecimal string generated from the user identiﬁer. <session-id> The identiﬁer of the user's streaming session. Each user streaming session generates a unique ID. <session-event> The event that generated the session script log. The event values are: SessionStart and SessionTermination. The following example folder structure applies to a streaming session started from the test- stack and test-ﬂeet. The session uses the API of user ID testuser@mydomain.com, from an AWS account ID of 123456789012, and the settings group test-stack in the US West (Oregon) Region (us-west-2): wspool-logs-us-west-2-1234567890123-abcdefg/test-stack/test-fleet/custom/ a0bcb1da11f480d9b5b3e90f91243143eac04cfccfbdc777e740fab628a1cd13/05yd1391-4805-3da6- f498-76f5x6746016/SessionScriptsLogs/SessionStart/ This example folder structure contains one log ﬁle for a user context session start script, and one log ﬁle for a system context session start script, if applicable. Monitoring WorkSpaces Pools Monitoring is an important part of maintaining the reliability, availability, and performance of your WorkSpaces Pools. Contents Monitoring WorkSpaces Pools 699 Amazon WorkSpaces Administration Guide • WorkSpaces Pools metrics and dimensions WorkSpaces Pools metrics and dimensions Amazon WorkSpaces sends the following WorkSpaces Pools metrics and dimension information to Amazon CloudWatch. WorkSpaces Pools sends metrics to CloudWatch one time every minute. The AWS/Workspaces namespace includes the following metrics. Pools usage metrics Metric Description ActiveUse rSessionC apacity ActualUse
workspaces-ag-234	workspaces-ag.pdf	234	ﬁle for a user context session start script, and one log ﬁle for a system context session start script, if applicable. Monitoring WorkSpaces Pools Monitoring is an important part of maintaining the reliability, availability, and performance of your WorkSpaces Pools. Contents Monitoring WorkSpaces Pools 699 Amazon WorkSpaces Administration Guide • WorkSpaces Pools metrics and dimensions WorkSpaces Pools metrics and dimensions Amazon WorkSpaces sends the following WorkSpaces Pools metrics and dimension information to Amazon CloudWatch. WorkSpaces Pools sends metrics to CloudWatch one time every minute. The AWS/Workspaces namespace includes the following metrics. Pools usage metrics Metric Description ActiveUse rSessionC apacity ActualUse rSessionC apacity Available UserSessi onCapacity The number of user sessions currently being used for streaming sessions. Units: Count Valid statistics: Average, Minimum, Maximum The total number of pool sessions that are available for streaming or are currently streaming. ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessionCapacity Units: Count Valid statistics: Average, Minimum, Maximum The number of idle pool sessions currently available for user streaming. AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessionCapacity Units: Count Valid statistics: Average, Minimum, Maximum WorkSpaces Pools metrics and dimensions 700 Amazon WorkSpaces Administration Guide Metric Description PendingUs erSession Capacity UserSessi onsCapaci tyUtilization The number of sessions being provisioned for your pool. Represents the additional number of streaming sessions the pool can support after provisioning is complete. Units: Count Valid statistics: Average, Minimum, Maximum The percentage of sessions in a pool that are being used, using the following formula. UserSessionCapacityUtilization = (ActiveUserSession Capacity / ActualUserSessionCapacity) * 100 Monitoring this metric helps with decisions about increasing or decreasing the value of a pool's desired capacity. Units: Percent Valid statistics: Average, Minimum, Maximum DesiredUs erSession Capacity The total number of sessions that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state. DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity Units: Count Valid statistics: Average, Minimum, Maximum WorkSpaces Pools metrics and dimensions 701 Amazon WorkSpaces Administration Guide Metric Description Insuffici entCapaci tyError The number of session requests rejected due to lack of capacity. You can set alarms to use this metric to be notiﬁed of users waiting for streaming sessions. Units: Count Valid statistics: Average, Minimum, Maximum, Sum Enable and Administer Persistent Storage for WorkSpaces Pools WorkSpaces Pools supports home folders for persistent storage. As a WorkSpaces Pools administrator, you must understand how to perform the following tasks to enable and administer persistent storage for your users. Contents • Enable and Administer Home Folders for Your WorkSpaces Pools Users Enable and Administer Home Folders for Your WorkSpaces Pools Users When you enable home folders for WorkSpaces Pools, users can access a persistent storage folder during their streaming sessions. No further conﬁguration is required for your users to access their home folder. Data stored by users in their home folder is automatically backed up to an Amazon Simple Storage Service bucket in your Amazon Web Services account and is made available to those users in subsequent sessions. Files and folders are encrypted in transit using Amazon S3's SSL endpoints. Files and folders are encrypted at rest using Amazon S3-managed encryption keys. Home folders are stored on WorkSpaces in WorkSpaces Pools in the following default locations: • For single-session, non-domain-joined Windows WorkSpaces: C:\Users\PhotonUser\My Files\Home Folder • Domain-joined Windows WorkSpaces: C:\Users\%username%\My Files\Home Folder Administer Persistent Storage 702 Amazon WorkSpaces Administration Guide As an administrator, use the applicable path if you conﬁgure your applications to save to the home folder. In some cases, your users may not be able to ﬁnd their home folder because some applications do not recognize the redirect that displays the home folder as a top-level folder in File Explorer. If this is the case, your users can access their home folder by browsing to the same directory in File Explorer. Contents • Files and Directories Associated with Compute-Intensive Applications • Enable Home Folders for Your WorkSpaces Pools Users • Administer Your Home Folders Files and Directories Associated with Compute-Intensive Applications During WorkSpaces Pools streaming sessions, saving large ﬁles and directories associated with compute-intensive applications to persistent storage can take longer than saving ﬁles and directories required for basic productivity applications. For example, it might take longer for applications to save a large amount of data or frequently modify the same ﬁles than it would to save ﬁles created by applications that perform a single write action. It might also take longer to save many small ﬁles. If your users save ﬁles and directories associated with compute-intensive applications and WorkSpaces Pools persistent storage options aren't performing as expected, we recommend that you use a Server Message Block (SMB) solution such as Amazon FSx for Windows File Server or an AWS Storage Gateway ﬁle gateway. Following are examples of ﬁles and directories associated with compute-intensive applications that are more suitable for use with these SMB solutions:
workspaces-ag-235	workspaces-ag.pdf	235	data or frequently modify the same ﬁles than it would to save ﬁles created by applications that perform a single write action. It might also take longer to save many small ﬁles. If your users save ﬁles and directories associated with compute-intensive applications and WorkSpaces Pools persistent storage options aren't performing as expected, we recommend that you use a Server Message Block (SMB) solution such as Amazon FSx for Windows File Server or an AWS Storage Gateway ﬁle gateway. Following are examples of ﬁles and directories associated with compute-intensive applications that are more suitable for use with these SMB solutions: • Workspace folders for integrated development environments (IDEs) • Local database ﬁles • Scratch space folders created by graphics simulation applications For more information, see File gateways in the AWS Storage Gateway User Guide. Enable Home Folders for Your WorkSpaces Pools Users Before enabling home folders, you must do the following: Administer Home Folders 703 Amazon WorkSpaces Administration Guide • Check that you have the correct AWS Identity and Access Management (IAM) permissions for Amazon S3 actions. • Use an image that was created from an AWS base image released on or after May 18, 2017. • Enable network connectivity to Amazon S3 from your virtual private cloud (VPC) by conﬁguring internet access or a VPC endpoint for Amazon S3. For more information, see Networking and Access for WorkSpaces Pools and Using Amazon S3 VPC Endpoints for WorkSpaces Pools Features. You can enable or disable home folders while creating a directory (see Conﬁgure SAML 2.0 and create a WorkSpaces Pools directory), or after the directory is created by using the AWS Management Console for WorkSpaces Pools. For each AWS Region, home folders are backed up by an Amazon S3 bucket. The ﬁrst time you enable home folders for an WorkSpaces Pools directory in an AWS Region, the service creates an Amazon S3 bucket in your account in that same Region. The same bucket is used to store the content of home folders for all users and all directories in that Region. For more information, see Amazon S3 Bucket Storage. To enable home folders while creating a directory • Follow the steps in Conﬁgure SAML 2.0 and create a WorkSpaces Pools directory, and make sure that Enable Home Folders is selected. To enable home folders for an existing directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the left navigation pane, choose Directories, and select the directory for which to enable home folders. 3. Below the directories list, choose Storage and select Enable Home Folders. 4. In the Enable Home Folders dialog box, choose Enable. Administer Your Home Folders Contents • Disable Home Folders • Amazon S3 Bucket Storage Administer Home Folders 704 Amazon WorkSpaces Administration Guide • Home Folder Content Synchronization • Home Folder Formats • Additional Resources Disable Home Folders You can disable home folders for a directory without losing user content already stored in home folders. Disabling home folders for a directory has the following eﬀects: • Users who are connected to active streaming sessions for the directory receive an error message. They are informed that they can no longer store content in their home folder. • Home folders do not appear for any new sessions that use the directory with home folders disabled. • Disabling home folders for one directory does not disable it for other directories. • Even if home folders are disabled for all directories, WorkSpaces Pools does not delete the user content. To restore access to home folders for the directory, enable home folders again by following the steps described earlier in this topic. To disable home folders while creating a directory • Follow the steps in Conﬁgure SAML 2.0 and create a WorkSpaces Pools directory and make sure that the Enable Home Folders option is cleared. To disable home folders for an existing directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the left navigation pane, choose Directories, and select the directory for which to enable home folders. 3. Below the directories list, choose Storage and clear Enable Home Folders. 4. In the Disable Home Folders dialog box, type CONFIRM (case-sensitive) to conﬁrm your choice, then choose Disable. Administer Home Folders 705 Amazon WorkSpaces Amazon S3 Bucket Storage Administration Guide WorkSpaces Pools manages user content stored in home folders by using Amazon S3 buckets created in your account. For every AWS Region, WorkSpaces Pools creates a bucket in your account. All user content generated from streaming sessions of directories in that Region is stored in that bucket. The buckets are fully managed by the service without any input or conﬁguration from an administrator. The buckets are named in a speciﬁc format as follows: wspool-home-folder-<region-code>-<account-id-without-hyphens>-<random-identifier> Where <region-code> is the AWS Region code in which the directory is created and <account- id-without-hyphens> is
workspaces-ag-236	workspaces-ag.pdf	236	705 Amazon WorkSpaces Amazon S3 Bucket Storage Administration Guide WorkSpaces Pools manages user content stored in home folders by using Amazon S3 buckets created in your account. For every AWS Region, WorkSpaces Pools creates a bucket in your account. All user content generated from streaming sessions of directories in that Region is stored in that bucket. The buckets are fully managed by the service without any input or conﬁguration from an administrator. The buckets are named in a speciﬁc format as follows: wspool-home-folder-<region-code>-<account-id-without-hyphens>-<random-identifier> Where <region-code> is the AWS Region code in which the directory is created and <account- id-without-hyphens> is your Amazon Web Services account ID, and >random-identifier< is a random identiﬁer number generated by the WorkSpaces service. The ﬁrst part of the bucket name, wspool-home-folder-, does not change across accounts or Regions. For example, if you enable home folders for directories in the US West (Oregon) Region (us-west-2) on account number 123456789012, the service creates an Amazon S3 bucket in that Region with the name shown. Only an administrator with suﬃcient permissions can delete this bucket. wspool-home-folder-us-west-2-123456789012 As mentioned earlier, disabling home folders for directories does not delete any user content stored in the Amazon S3 bucket. To permanently delete user content, an administrator with adequate access must do so from the Amazon S3 console. WorkSpaces Pools adds a bucket policy that prevents accidental deletion of the bucket. Home Folder Content Synchronization When home folders are enabled, WorkSpaces Pools creates a unique folder for each user in which to store their content. The folder is created as a unique Amazon S3 preﬁx that uses a hash of the user name within an S3 bucket for your Amazon Web Services account and Region. After WorkSpaces Pools creates the home folder in Amazon S3, it copies the accessed content in that folder from the S3 bucket to the WorkSpace. This enables the user to access their home folder content quickly, from the WorkSpace in the WorkSpace Pool, during their streaming session. Changes that you make to a user’s home folder content in an S3 bucket and that the user makes to their home folder content on a WorkSpace in the WorkSpace Pool are synchronized between Amazon S3 and WorkSpaces Pools as follows. Administer Home Folders 706 Amazon WorkSpaces Administration Guide 1. At the beginning of a user’s WorkSpaces Pools streaming session, WorkSpaces Pools catalogs the home folder ﬁles that are stored for that user in the Amazon S3 bucket for your Amazon Web Services account and Region. 2. A user’s home folder content is also stored on the WorkSpace in WorkSpaces Pools from which they stream. When a user accesses their home folder on the WorkSpace, the list of cataloged ﬁles is displayed. 3. WorkSpaces Pools downloads a ﬁle from the S3 bucket to the WorkSpace only after the user uses a streaming application to open the ﬁle during their streaming session. 4. After WorkSpaces Pools downloads the ﬁle to the WorkSpace, synchronization occurs after the ﬁle is accessed 5. If the user changes the ﬁle during their streaming session, WorkSpaces Pools uploads the new version of the ﬁle from the WorkSpace to the S3 bucket periodically or at the end of the streaming session. However, the ﬁle is not downloaded from the S3 bucket again during the streaming session. The following sections describe synchronization behavior when you add, replace, or remove a user's home folder ﬁle in Amazon S3. Contents • Synchronization of ﬁles that you add to a user’s home folder in Amazon S3 • Synchronization of ﬁles that you replace in a user’s home folder in Amazon S3 • Synchronization of ﬁles that you remove from a user’s home folder in Amazon S3 Synchronization of ﬁles that you add to a user’s home folder in Amazon S3 If you add a new ﬁle to a user’s home folder in an S3 bucket, WorkSpaces Pools catalogs the ﬁle and displays it in the list of ﬁles in the user’s home folder within a few minutes. However, the ﬁle isn’t downloaded from the S3 bucket to the WorkSpace until the user opens the ﬁle with an application during their streaming session. Synchronization of ﬁles that you replace in a user’s home folder in Amazon S3 If a user opens a ﬁle in their home folder on the WorkSpace in the WorkSpace Pool during their streaming session, and you replace the same ﬁle in their home folder in an S3 bucket with a new version during that user’s active streaming session, the new version of the ﬁle is not immediately Administer Home Folders 707 Amazon WorkSpaces Administration Guide downloaded to the WorkSpace. The new version is downloaded from the S3 bucket to the WorkSpace only after the user starts a new streaming session and opens the ﬁle again. Synchronization of ﬁles
workspaces-ag-237	workspaces-ag.pdf	237	home folder in Amazon S3 If a user opens a ﬁle in their home folder on the WorkSpace in the WorkSpace Pool during their streaming session, and you replace the same ﬁle in their home folder in an S3 bucket with a new version during that user’s active streaming session, the new version of the ﬁle is not immediately Administer Home Folders 707 Amazon WorkSpaces Administration Guide downloaded to the WorkSpace. The new version is downloaded from the S3 bucket to the WorkSpace only after the user starts a new streaming session and opens the ﬁle again. Synchronization of ﬁles that you remove from a user’s home folder in Amazon S3 If a user opens a ﬁle in their home folder on the WorkSpace in the WorkSpace Pool during their streaming session, and you remove the ﬁle from their home folder in an S3 bucket during that user’s active streaming session, the ﬁle is removed from the WorkSpace after the user does either of the following: • Opens the home folder again • Refreshes the home folder Home Folder Formats The hierarchy of a user folder depends on how a user launches a streaming session, as described in the following section. SAML 2.0 For sessions created using SAML federation, the user folder structure is as follows: bucket-name/user/federated/user-id-SHA-256-hash/ In this case, user-id-SHA-256-hash is the folder name created using a lowercase SHA-256 hash hexadecimal string generated from the NameID SAML attribute value passed in the SAML federation request. To diﬀerentiate users who have the same name but belong to two diﬀerent domains, send the SAML request with NameID in the format domainname\username. For more information, see Conﬁgure SAML 2.0 and create a WorkSpaces Pools directory. The following example folder structure applies to session access using SAML federation with NameID SAMPLEDOMAIN\testuser, account ID 123456789012 in the US West (Oregon) Region: wspool-home-folder-us-west-2-123456789012/user/ federated/8dd9a642f511609454d344d53cb861a71190e44fed2B8aF9fde0C507012a9901 When part or all of the NameID string is capitalized (as the domain name SAMPLEDOMAIN is in the example), WorkSpaces Pools generates the hash value based on the capitalization used in the string. Using this example, the hash value for SAMPLEDOMAIN\testuser is Administer Home Folders 708 Amazon WorkSpaces Administration Guide 8DD9A642F511609454D344D53CB861A71190E44FED2B8AF9FDE0C507012A9901. In the folder for that user, this value is displayed in lowercase, as follows: 8dd9a642f511609454d344d53cb861a71190e44fed2B8aF9fde0C507012a9901. You can identify the folder for a user by generating the SHA-256 hash value of the NameID using websites or open source coding libraries available online. Additional Resources For more information about managing Amazon S3 buckets and best practices, see the following topics in the Amazon Simple Storage Service User Guide: • You can provide oﬄine access to user data for your users with Amazon S3 policies. For more information, see Amazon S3: Allows IAM Users Access to Their S3 Home Directory, Programmatically and In the Console in the IAM User Guide. • You can enable ﬁle versioning for content stored in Amazon S3 buckets used by WorkSpaces Pools. For more information, see Using Versioning. Enable application settings persistence for your WorkSpaces Pools users WorkSpaces Pools supports persistent application settings for Windows-based directories. This means that your users' application customizations and Windows settings are automatically saved after each streaming session and applied during the next session. Examples of persistent application settings that your users can conﬁgure include, but are not limited to, browser favorites, settings, webpage sessions, application connection proﬁles, plugins, and UI customizations. These settings are saved to an Amazon Simple Storage Service (Amazon S3) bucket in your account, within the AWS Region in which application settings persistence is enabled. They are available in each WorkSpaces Pools streaming session. Note Standard Amazon S3 charges may apply to data that is stored in your S3 bucket. For more information, see Amazon S3 Pricing. Contents Enable application settings persistence for your users 709 Amazon WorkSpaces Administration Guide • How application settings persistence works • Enabling application settings persistence • Administer the VHDs for your users' application settings How application settings persistence works Persistent application settings are saved to a Virtual Hard Disk (VHD) ﬁle. This ﬁle is created the ﬁrst time a user streams an application from a directory on which application settings persistence is enabled. If the WorkSpace Pool associated with the directory is based on an image that contains default application and Windows settings, the default settings are used for the user's ﬁrst streaming session. When the streaming session ends, the VHD is unmounted and uploaded to an Amazon S3 bucket within your account. The bucket is created when you enable persistent application settings for the ﬁrst time for a directory in an AWS Region. The bucket is unique to your AWS account and the Region. The VHD is encrypted in transit using Amazon S3 SSL endpoints, and at rest using AWS Managed CMKs. The VHD is mounted to the WorkSpace in both C:\Users\%username%
workspaces-ag-238	workspaces-ag.pdf	238	on an image that contains default application and Windows settings, the default settings are used for the user's ﬁrst streaming session. When the streaming session ends, the VHD is unmounted and uploaded to an Amazon S3 bucket within your account. The bucket is created when you enable persistent application settings for the ﬁrst time for a directory in an AWS Region. The bucket is unique to your AWS account and the Region. The VHD is encrypted in transit using Amazon S3 SSL endpoints, and at rest using AWS Managed CMKs. The VHD is mounted to the WorkSpace in both C:\Users\%username% and D:\%username %. If your WorkSpace is not joined to an Active Directory domain, the Windows user name is PhotonUser. If your WorkSpace is joined to an Active Directory domain, the Windows user name is that of the logged in user. Application settings persistence does not work across diﬀerent operating system versions. For example, if you enable application settings persistence for a WorkSpace Pool that uses a Windows Server 2019 image, if you update the WorkSpace Pool to use an image that runs a diﬀerent operating system (such as Windows Server 2022), settings from previous streaming sessions are not saved for users of the directory. Instead, after you update the WorkSpace Pool to use the new image, when users launch a streaming session from a WorkSpace, a new Windows user proﬁle is created. However, if you apply an update to the same operating system on the image, users' customizations and settings from previous streaming sessions are saved. When updates to the same operating system are applied to an image, the same Windows user proﬁle is used when users launch a streaming session from the WorkSpace. Important WorkSpaces Pools supports applications that rely on the Microsoft Data Protection API only when the WorkSpace is joined to a Microsoft Active Directory domain. In cases where How application settings persistence works 710 Amazon WorkSpaces Administration Guide a WorkSpace is not joined to an Active Directory domain, the Windows user, PhotonUser, is diﬀerent on each WorkSpace. Due to the way in which the DPAPI security model works, users' passwords don’t persist for applications that use DPAPI in this scenario. In cases where WorkSpaces are joined to an Active Directory domain and the user is a domain user, the Windows user name is that of the logged in user, and users’ passwords persist for applications that use DPAPI. WorkSpaces Pools automatically saves all ﬁles and folders in this path, except for the following folders: • Contacts • Desktop • Documents • Downloads • Links • Pictures • Saved Games • Searches • Videos Files and folders created outside of these folders are saved within the VHD and synced to Amazon S3. The default VHD maximum size is 5 GB for Pools. The size of the saved VHD is the total size of the ﬁles and folders that it contains. WorkSpaces Pools automatically saves the HKEY_CURRENT_USER registry hive for the user. For new users (users whose proﬁles don't exist in Amazon S3), WorkSpaces Pools creates the initial proﬁle by using the default proﬁle. This proﬁle is created in the following location on the image builder: C:\users\default. Note The entire VHD must be downloaded to the WorkSpace before a streaming session can begin. For this reason, a VHD that contains a large amount of data can delay the start of the streaming session. For more information, see Best practices for enabling application settings persistence. How application settings persistence works 711 Amazon WorkSpaces Administration Guide When you enable application settings persistence, you must specify a settings group. The settings group determines which saved application settings are used for a streaming session from this directory. WorkSpaces Pools creates a new VHD ﬁle for the settings group that is stored separately within the S3 bucket in your AWS account. If the settings group is shared between directories, the same application settings are used in each directory. If a directory requires its own application settings, specify a unique settings group for the directory. Enabling application settings persistence Contents • Prerequisites for enabling application settings persistence • Best practices for enabling application settings persistence • How to enable application settings persistence Prerequisites for enabling application settings persistence To enable application settings persistence, you must ﬁrst do the following: • Use an image that was created from a base image published by AWS on or after December 7, 2017. • Enable network connectivity to Amazon S3 from your virtual private cloud (VPC) by conﬁguring internet access or a VPC endpoint for Amazon S3. For more information, see the Home Folders and VPC Endpoints section in Networking and Access for WorkSpaces Pools. Best practices for enabling application settings persistence To enable application settings persistence without providing internet access to your WorkSpaces, use a VPC
workspaces-ag-239	workspaces-ag.pdf	239	for enabling application settings persistence To enable application settings persistence, you must ﬁrst do the following: • Use an image that was created from a base image published by AWS on or after December 7, 2017. • Enable network connectivity to Amazon S3 from your virtual private cloud (VPC) by conﬁguring internet access or a VPC endpoint for Amazon S3. For more information, see the Home Folders and VPC Endpoints section in Networking and Access for WorkSpaces Pools. Best practices for enabling application settings persistence To enable application settings persistence without providing internet access to your WorkSpaces, use a VPC endpoint. This endpoint must be in the VPC to which your WorkSpaces in WorkSpaces Pools are connected. You must attach a custom policy to enable WorkSpaces Pools access to the endpoint. For information about how to create the custom policy, see the Home Folders and VPC Endpoints section in Networking and Access for WorkSpaces Pools. For more information about private Amazon S3 endpoints, see VPC Endpoints and Endpoints for Amazon S3 in the Amazon VPC User Guide. Enabling application settings persistence 712 Amazon WorkSpaces Administration Guide How to enable application settings persistence You can enable or disable application settings persistence while creating a directory or after the directory is created by using the WorkSpaces console. For each AWS Region, persistent application settings are stored in an S3 bucket in your account. The ﬁrst time you enable application settings persistence for a directory in an AWS Region, WorkSpaces Pools creates an S3 bucket in your AWS account in the same Region. The same bucket stores the application settings VHD ﬁle for all users and all directories in that AWS Region. For more information, see Amazon S3 Bucket Storage in Administer the VHDs for your users' application settings. To enable application settings persistence while creating a directory • Follow the steps in Conﬁgure SAML 2.0 and create a WorkSpaces Pools directory, and make sure that Enable Application Settings Persistence is selected. To enable application settings persistence for an existing directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the left navigation pane, choose Pools, and select the pool for which to enable application persistence. 3. Choose Edit in the Settings section of the page. 4. In the Application Persistence section of the page, select Enable Application settings persistence. 5. Choose Save changes. New streaming sessions now have application settings persistence enabled. Administer the VHDs for your users' application settings Contents • Amazon S3 bucket storage • Reset a user's application settings • Enable Amazon S3 object versioning and revert a user's application settings • Increase the size of the application settings VHD Administer the VHDs for your users' application settings 713 Amazon WorkSpaces Administration Guide Amazon S3 bucket storage When you enable application settings persistence, your users’ application customizations and Windows settings are automatically saved to a Virtual Hard Disk (VHD) ﬁle that is stored in an Amazon S3 bucket created in your AWS account. For every AWS Region, WorkSpaces Pools creates a bucket in your account that is unique to your account and the Region. All application settings conﬁgured by your users are stored in the bucket for that Region. You do not need to perform any conﬁguration tasks to manage these S3 buckets; they are fully managed by the WorkSpaces Pools service. The VHD ﬁle that is stored in each bucket is encrypted in transit using Amazon S3's SSL endpoints and at rest using AWS Managed CMKs. The buckets are named in a speciﬁc format as follows: wspool-app-settings-<region-code>-<account-id-without-hyphens>-<random-identifier> region-code This is the AWS Region code in which the directory is created with application settings persistence. account-id-without-hyphens Your AWS account ID. The random identiﬁer ensures there is no conﬂict with other buckets in that Region. The ﬁrst part of the bucket name, wspool-app-settings, does not change across accounts or Regions. For example, if you enable application settings persistence for directories in the US West (Oregon) Region (us-west-2) on account number 123456789012, WorkSpaces Pools creates an Amazon S3 bucket within your account in that Region with the name shown. Only an administrator with suﬃcient permissions can delete this bucket. wspool-app-settings-us-west-2-1234567890123-abcdefg Disabling application settings persistence does not delete any VHDs stored in the S3 bucket. To permanently delete settings VHDs, you or another administrator with adequate permissions must do so by using the Amazon S3 console or API. WorkSpaces Pools adds a bucket policy that prevents accidental deletion of the bucket. Administer the VHDs for your users' application settings 714 Amazon WorkSpaces Administration Guide When application settings persistence is enabled, a unique folder is created for each settings group to store the settings VHD. The hierarchy of the folder in the S3 bucket depends on how the user launches a streaming session, as described in the following section. The path for the
workspaces-ag-240	workspaces-ag.pdf	240	the S3 bucket. To permanently delete settings VHDs, you or another administrator with adequate permissions must do so by using the Amazon S3 console or API. WorkSpaces Pools adds a bucket policy that prevents accidental deletion of the bucket. Administer the VHDs for your users' application settings 714 Amazon WorkSpaces Administration Guide When application settings persistence is enabled, a unique folder is created for each settings group to store the settings VHD. The hierarchy of the folder in the S3 bucket depends on how the user launches a streaming session, as described in the following section. The path for the folder where the settings VHD is stored in the S3 bucket in your account uses the following structure: bucket-name/Windows/prefix/settings-group/access-mode/user-id-SHA-256-hash bucket-name The name of the S3 bucket in which users' application settings are stored. The name format is described earlier in this section. prefix The Windows version-speciﬁc preﬁx. For example, v4 for Windows Server 2012 R2. settings-group The settings group value. This value is applied to one or more directories that share the same the same application settings. access-mode The identity method of the user: custom for the WorkSpaces Pools API or CLI, federated for SAML, and userpool for user pool users. user-id-SHA-256-hash The user-speciﬁc folder name. This name is created using a lowercase SHA-256 hash hexadecimal string generated from the user ID. The following example folder structure applies to a streaming session that is accessed using the API or CLI with a user ID of testuser@mydomain.com, an AWS account ID of 123456789012, and the settings group test-stack in the US West (Oregon) Region (us-west-2): wspool-app-settings-us-west-2-1234567890123-abcdefg/Windows/v4/test-stack/custom/ a0bcb1da11f480d9b5b3e90f91243143eac04cfccfbdc777e740fab628a1cd13 You can identify the folder for a user by generating the lowercase SHA-256 hash value of the user ID using websites or open source coding libraries available online. Administer the VHDs for your users' application settings 715 Amazon WorkSpaces Administration Guide Reset a user's application settings To reset a user's application settings, you must ﬁnd and delete the VHD and associated metadata ﬁle from the S3 bucket in your AWS account. Make sure that you do not do this during a user's active streaming session. After you delete the user's VHD and the metadata ﬁle, the next time the user launches a session from a streaming instance that has application settings persistence enabled, WorkSpaces Pools creates a new settings VHD for that user. To reset a user's application settings 1. Open the Amazon S3 console at https://console.aws.amazon.com/s3/. 2. 3. 4. 5. In the Bucket name list, choose the S3 bucket that contains the application settings VHD that you want to reset. Locate the folder that contains the VHD. For more information about how to navigate the S3 bucket folder structure, see Amazon S3 Bucket Storage earlier in this topic. In the Name list, select the check box next to the VHD and the REG, choose More, and then choose Delete. In the Delete objects dialog box, verify that the VHD and the REG are listed, and then choose Delete. The next time the user streams from a pool on which application settings persistence is enabled with the applicable settings group, a new application settings VHD is created. This VHD is saved to the S3 bucket at the end of the session. Enable Amazon S3 object versioning and revert a user's application settings You can use Amazon S3 object versioning and lifecycle policies to manage your users’ application settings when your users change them. With Amazon S3 object versioning, you can preserve, retrieve, and restore every version of the settings VHD. This enables you to recover from both unintended user actions and application failures. When versioning is enabled, after each streaming session, a new version of the application settings VHD is synced to Amazon S3. The new version does not overwrite the previous version, so if an issue with your users' settings occurs, you can revert to a previous version of the VHD. Administer the VHDs for your users' application settings 716 Amazon WorkSpaces Note Administration Guide Each version of the application settings VHD is saved to Amazon S3 as a separate object and is charged accordingly. Object versioning is not enabled by default in your S3 bucket, so you must explicitly enable it. To enable object versioning for your application settings VHD 1. Open the Amazon S3 console at https://console.aws.amazon.com/s3/. 2. In the Bucket name list, choose the S3 bucket that contains the application settings VHD on which to enable object versioning. 3. Choose Properties. 4. Choose Versioning, Enable versioning, and then choose Save. To expire older versions of your application settings VHDs, you can use Amazon S3 lifecycle policies. For information, see How Do I Create a Lifecycle Policy for an S3 Bucket? in the Amazon Simple Storage Service User Guide. To revert a user's application settings VHD You can revert to a
workspaces-ag-241	workspaces-ag.pdf	241	enable object versioning for your application settings VHD 1. Open the Amazon S3 console at https://console.aws.amazon.com/s3/. 2. In the Bucket name list, choose the S3 bucket that contains the application settings VHD on which to enable object versioning. 3. Choose Properties. 4. Choose Versioning, Enable versioning, and then choose Save. To expire older versions of your application settings VHDs, you can use Amazon S3 lifecycle policies. For information, see How Do I Create a Lifecycle Policy for an S3 Bucket? in the Amazon Simple Storage Service User Guide. To revert a user's application settings VHD You can revert to a previous version of a user's application settings VHD by deleting newer versions of the VHD from the applicable S3 bucket. Do not do this when the user has an active streaming session. 1. Open the Amazon S3 console at https://console.aws.amazon.com/s3/. 2. In the Bucket name list, choose the S3 bucket that contains the user's application settings VHD version to revert to. 3. Locate and select the folder that contains the VHD. For information about how to navigate the S3 bucket folder structure, see Amazon S3 Bucket Storage earlier in this topic. 4. 5. 6. When you select the folder, the settings VHD and associated metadata ﬁle display. To display a list of the VHD and metadata ﬁle versions, choose Show. Locate the version of the VHD to revert to. In the Name list, select the check boxes next to the newer versions of the VHD and associated metadata ﬁles, choose More, and then choose Delete. Administer the VHDs for your users' application settings 717 Amazon WorkSpaces Administration Guide 7. Verify that the application settings VHD that you want to revert to and the associated metadata ﬁle are the newest versions of these ﬁles. The next time the user streams from a pool on which application settings persistence is enabled with the applicable settings group, the reverted version of the user's settings displays. Increase the size of the application settings VHD The default VHD maximum size is 5 GB for Pools. If a user requires additional space for application settings, you can download the applicable application settings VHD to a Windows computer to expand it. Then, replace the current VHD in the S3 bucket with the larger one. Do not do this when the user has an active streaming session. Note To reduce the physical size of the virtual hard disk (VHD), clear the recycle bin before ending a session. This also reduces upload and download times, and improves the overall user experience. To increase the size of the application settings VHD Note The full VHD must be downloaded before a user can stream applications. Increasing the size of an application settings VHD can increase the time it takes for users to start application streaming sessions. 1. Open the Amazon S3 console at https://console.aws.amazon.com/s3/. 2. In the Bucket name list, choose the S3 bucket that contains the application settings VHD to expand. 3. Locate and select the folder that contains the VHD. For information about how to navigate the S3 bucket folder structure, see Amazon S3 bucket storage earlier in this topic. When you select the folder, the settings VHD and associated metadata ﬁle display. Administer the VHDs for your users' application settings 718 Amazon WorkSpaces Administration Guide 4. Download the Profile.vhdx ﬁle to a directory on your Windows computer. Do not close your browser after the download completes, because you'll use the browser again later to upload the expanded VHD. 5. To use Diskpart to increase the size of the VHD to 7 GB, open the command prompt as an administrator, and type the following commands. diskpart select vdisk file="C:\path\to\application\settings\profile.vhdx" expand vdisk maximum=7000 6. Then, type the following Diskpart commands to ﬁnd and attach the VHD, and display the list of volumes: elect vdisk file="C:\path\to\application\settings\profile.vhdx" attach vdisk list volume In the output, make note of the volume number with the label "AwsEucUsers". In the next step, you select this volume so that you can enlarge it. 7. Type the following command in which <volume-number> is the number in the list volume output. select volume <volume-number> 8. Type the following command: extend 9. Type the following commands to conﬁrm that the size of the partition on the VHD increased as expected (7 GB in this example): diskpart Administer the VHDs for your users' application settings 719 Amazon WorkSpaces Administration Guide select vdisk file="C:\path\to\application\settings\profile.vhdx" list volume 10. Type the following command to detach the VHD so that it can be uploaded: detach vdisk 11. Return to your browser with the Amazon S3 console, choose Upload, Add ﬁles, and then select the enlarged VHD. 12. Choose Upload. After the VHD is uploaded, the next time the user streams from a pool on which application settings persistence is enabled with the applicable settings group,
workspaces-ag-242	workspaces-ag.pdf	242	size of the partition on the VHD increased as expected (7 GB in this example): diskpart Administer the VHDs for your users' application settings 719 Amazon WorkSpaces Administration Guide select vdisk file="C:\path\to\application\settings\profile.vhdx" list volume 10. Type the following command to detach the VHD so that it can be uploaded: detach vdisk 11. Return to your browser with the Amazon S3 console, choose Upload, Add ﬁles, and then select the enlarged VHD. 12. Choose Upload. After the VHD is uploaded, the next time the user streams from a pool on which application settings persistence is enabled with the applicable settings group, the larger application settings VHD is available. WorkSpaces Pools troubleshooting notiﬁcation codes The following are notiﬁcation codes and resolution steps for issues with domain join that you might encounter when you set up and use Active Directory with WorkSpaces. DOMAIN_JOIN_ERROR_ACCESS_DENIED Message: Access is denied. Resolution: The service account speciﬁed in the directory does not have permissions to create the computer object or reuse an existing one. Validate the permissions and start the WorkSpaces pool. DOMAIN_JOIN_ERROR_LOGON_FAILURE Message: The username or password is incorrect. Resolution: The service account speciﬁed in the directory has an invalid username or password. Update the credentials in the AWS Secrets Manager secret conﬁgured in the directory, and start the WorkSpaces pool again. DOMAIN_JOIN_NERR_PASSWORD_EXPIRED Message: The password of this user has expired. Troubleshooting notiﬁcation codes 720 Amazon WorkSpaces Administration Guide Resolution: The password for the service account in the AWS Secrets Manager secret has expired. First, stop the WorkSpaces pool. Next, change the password for the secret speciﬁed in the WorkSpaces directory. Then, start the WorkSpaces pool. DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED Message: Your computer could not be joined to the domain. You have exceeded the maximum number of computer accounts you are allowed to create in this domain. Contact your system administrator to have this limit reset or increased. Resolution: The service account speciﬁed on the directory does not have permissions to create the computer object or reuse an existing one. Validate the permissions and start the WorkSpaces pool. DOMAIN_JOIN_ERROR_INVALID_PARAMETER Message: A parameter is incorrect. This error is returned if the LpName parameter is NULL or the NameType parameter is speciﬁed as NetSetupUnknown or an unknown nametype. Resolution: This error can occur when the distinguished name for the OU is incorrect. Validate the OU and try again. If you continue to encounter this error, contact AWS Support. For more information, see AWS Support Center. DOMAIN_JOIN_ERROR_MORE_DATA Message: More data is available. Resolution: This error can occur when the distinguished name for the OU is incorrect. Validate the OU and try again. If you continue to encounter this error, contact AWS Support. For more information, see AWS Support Center. DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN Message: The speciﬁed domain either does not exist or could not be contacted. Resolution: The streaming instance was unable to contact your Active Directory domain. To ensure network connectivity, conﬁrm your VPC, subnet, and security group settings. DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED Message: The Workstation service has not been started. Resolution: An error occurred starting the Workstation service. Ensure that the service is enabled in your image. If you continue to encounter this error, contact AWS Support. For more information, see AWS Support Center. Troubleshooting notiﬁcation codes 721 Amazon WorkSpaces Administration Guide DOMAIN_JOIN_ERROR_NOT_SUPPORTED Message: The request is not supported. This error is returned if a remote computer was speciﬁed in the lpServer parameter and this call is not supported on the remote computer. Resolution: Contact AWS Support for assistance. For more information, see AWS Support Center. DOMAIN_JOIN_ERROR_FILE_NOT_FOUND Message: The system cannot ﬁnd the ﬁle speciﬁed. Resolution: This error occurs when an invalid organizational unit (OU) distinguished name is provided. The distinguished name must start with OU=. Validate the OU distinguished name and try again. DOMAIN_JOIN_INTERNAL_SERVICE_ERROR Message: The account already exists. Resolution: This error can occur in the following scenarios: • If the issue isn't permissions-related, check the Netdom logs for errors and make sure that you provided the correct OU. • The service account speciﬁed in the directory does not have permissions to create the computer object or reuse an existing one. If this is the case, validate the permissions and start the WorkSpaces pool. • After WorkSpaces creates the computer object, it is moved from the OU in which it was created. In this case, the ﬁrst WorkSpaces pool is created successfully, but any new WorkSpaces pool that uses the computer object fails. When Active Directory searches for the computer object in the speciﬁed OU and detects that an object with the same name exists elsewhere in the domain, the domain join is not successful. • The name of the OU speciﬁed in the WorkSpaces directory includes spaces before or after the commas in the directory. In this case, when a WorkSpaces pool attempts to rejoin the Active Directory domain, WorkSpaces cannot cycle the computer objects
workspaces-ag-243	workspaces-ag.pdf	243	OU in which it was created. In this case, the ﬁrst WorkSpaces pool is created successfully, but any new WorkSpaces pool that uses the computer object fails. When Active Directory searches for the computer object in the speciﬁed OU and detects that an object with the same name exists elsewhere in the domain, the domain join is not successful. • The name of the OU speciﬁed in the WorkSpaces directory includes spaces before or after the commas in the directory. In this case, when a WorkSpaces pool attempts to rejoin the Active Directory domain, WorkSpaces cannot cycle the computer objects correctly and the domain rejoin does not succeed. To resolve this issue for a WorkSpaces pool, do the following: 1. 2. Stop the WorkSpaces pool. Edit the Active Directory domain settings for the WorkSpaces pool to remove the directory and Directory OU to which the WorkSpaces pool is joined. 3. Update the WorkSpaces directory to specify an OU that doesn't contain spaces. Troubleshooting notiﬁcation codes 722 Amazon WorkSpaces Administration Guide 4. Edit the Active Directory domain settings for the WorkSpaces pool to specify the directory with the updated Directory OU. To resolve this issue for a WorkSpaces pool, do the following: 1. Delete the WorkSpaces pool. 2. Update the WorkSpaces directory to specify an OU that doesn't contain spaces. 3. Create a new WorkSpaces pool and specify the directory with the updated Directory OU. WORKSPACES_POOL_SESSION_RESERVATION_ERROR Message: We currently do not have suﬃcient capacity for requested sessions in the availability zones [us-west-1] for subnets associated with your WorkSpaces Pool. Our system will be working on provisioning additional capacity. Meanwhile, please change or associate a diﬀerent subnet using one of the following AZs [us-west-2, us-west-3]. Resolution: Wait until EC2 has enough capacity or update subnets in other AZs on the directory. INSUFFICIENT_CAPACITY_ERROR_WORKSPACES_POOL_AZ Message: We currently don't have suﬃcient capacity for requested sessions in availability zone (AZs) [<impacted az>]. Our system will be working on provisioning additional capacity. Meanwhile please change or associate another subnet using other AZs to your WorkSpaces Pool. Resolution: Wait until Amazon EC2 has enough capacity or update subnets in other AZs on the directory. INVALID_CUSTOMER_SUBNET_CIDR_BLOCK Message: Your subnet includes use of an unavailable CIDR range. Please update your subnets outside of the current /18 range.”. Resolution: Wait until EC2 has enough capacity or update subnets in other AZs on the directory. Troubleshooting notiﬁcation codes 723 Amazon WorkSpaces Administration Guide Security in Amazon WorkSpaces Cloud security at AWS is the highest priority. As an AWS customer, you beneﬁt from a data center and network architecture that is 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 eﬀectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to WorkSpaces, 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. It shows you how to conﬁgure WorkSpaces to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your WorkSpaces resources. Contents • Data protection in Amazon WorkSpaces • Identity and access management for WorkSpaces • Compliance validation for Amazon WorkSpaces • Resilience in Amazon WorkSpaces • Infrastructure security in Amazon WorkSpaces • Update management in WorkSpaces Data protection in Amazon WorkSpaces The AWS shared responsibility model applies to data protection in Amazon WorkSpaces. As described in this model, AWS is responsible for protecting the global infrastructure that runs all Data protection 724 Amazon WorkSpaces Administration Guide 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 conﬁguration and 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
workspaces-ag-244	workspaces-ag.pdf	244	responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security conﬁguration and 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 fulﬁll 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 conﬁdential or sensitive information, such as your customers' email addresses, into tags or free-form text ﬁelds such as a Name ﬁeld. This includes when you work with WorkSpaces or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text ﬁelds 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. For more information about WorkSpaces and FIPS endpoint encryption, see Conﬁgure FedRAMP authorization or DoD SRG compliance for WorkSpaces Personal. Encryption at rest You can encrypt the storage volumes for your WorkSpaces using AWS KMS Key from AWS Key Management Service. For more information, see Encrypted WorkSpaces in WorkSpaces Personal. Encryption at rest 725 Amazon WorkSpaces Administration Guide When you create WorkSpaces with encrypted volumes, WorkSpaces uses Amazon Elastic Block Store (Amazon EBS) to create and manage those volumes. EBS encrypts your volumes with a data key using the industry-standard AES-256 algorithm. For more information, see Amazon EBS Encryption in the Amazon EC2 User Guide. Encryption in transit For PCoIP, data in-transit is encrypted using TLS 1.2 encryption and SigV4 request signing. The PCoIP protocol uses encrypted UDP traﬃc, with AES encryption, for streaming pixels.The streaming connection, using port 4172 (TCP and UDP), is encrypted by using AES-128 and AES-256 ciphers, but the encryption defaults to 128-bit. You can change this default to 256-bit, either by using the Conﬁgure PCoIP Security Settings Group Policy setting for Windows WorkSpaces, or by modifying the PCoIP Security Settings in the pcoip-agent.conf ﬁle for Amazon Linux WorkSpaces. To learn more about Group Policy administration for Amazon WorkSpaces, see Conﬁgure PCoIP security settings in Manage your Windows WorkSpaces in WorkSpaces Personal. To learn more about modifying the pcoip-agent.conf ﬁle, see Control PCoIP Agent behavior on Amazon Linux WorkSpaces and PCoIP Security Settings in the Teradici documentation. For DCV, streaming and control data in-transit is encrypted using TLS 1.3 encryption for UDP traﬃc and TLS 1.2 encryption for TCP traﬃc, with AES-256 ciphers. Identity and access management for WorkSpaces By default, IAM users don't have permissions for WorkSpaces resources and operations. To allow IAM users to manage WorkSpaces resources, you must create an IAM policy that explicitly grants them permissions, and attach the policy to the IAM users or groups that require those permissions. Note Amazon WorkSpaces doesn’t support the provisioning of IAM credentials into a WorkSpace (such as with an instance proﬁle). To provide access, add permissions to your users, groups, or roles: • Users and groups in AWS IAM Identity Center: Encryption in transit 726 Amazon WorkSpaces Administration Guide Create a permission set. Follow the instructions in Create a permission set in the AWS IAM Identity Center User Guide. • Users managed in IAM through an identity provider: Create a role for identity federation. Follow the instructions in Create a role for a third-party identity provider (federation) in the IAM User Guide. • IAM users: • Create a role that your user can assume. Follow the instructions in Create a role for an IAM user in the IAM User Guide. • (Not
workspaces-ag-245	workspaces-ag.pdf	245	• Users and groups in AWS IAM Identity Center: Encryption in transit 726 Amazon WorkSpaces Administration Guide Create a permission set. Follow the instructions in Create a permission set in the AWS IAM Identity Center User Guide. • Users managed in IAM through an identity provider: Create a role for identity federation. Follow the instructions in Create a role for a third-party identity provider (federation) in the IAM User Guide. • IAM users: • Create a role that your user can assume. Follow the instructions in Create a role for an IAM user in the IAM User Guide. • (Not recommended) Attach a policy directly to a user or add a user to a user group. Follow the instructions in Adding permissions to a user (console) in the IAM User Guide. Following are additional resources for IAM: • For more information about IAM policies, see Policies and Permissions in the IAM User Guide guide. • For more information about IAM, see Identity and Access Management (IAM) and the IAM User Guide. • For more information about WorkSpaces-speciﬁc resources, actions, and condition context keys for use in IAM permission policies, see Actions, Resources, and Condition Keys for Amazon WorkSpaces in the IAM User Guide. • For a tool that helps you create IAM policies, see the AWS Policy Generator. You can also use the IAM Policy Simulator to test whether a policy would allow or deny a speciﬁc request to AWS. Contents • Example policies • Specify WorkSpaces resources in an IAM policy • Create the workspaces_DefaultRole Role • Create the AmazonWorkSpacesPCAAccess service role • AWS managed policies for WorkSpaces • Access to WorkSpaces and scripts on streaming instances Identity and access management 727 Amazon WorkSpaces Example policies Administration Guide The following examples show policy statements that you could use to control the permissions that IAM users have to Amazon WorkSpaces. Example 1: Grant access to perform WorkSpaces personal and pools tasks The following policy statement grants an IAM user permission to perform WorkSpaces personal and pools tasks. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ds:", "workspaces:", "application-autoscaling:DeleteScalingPolicy", "application-autoscaling:DeleteScheduledAction", "application-autoscaling:DeregisterScalableTarget", "application-autoscaling:DescribeScalableTargets", "application-autoscaling:DescribeScalingActivities", "application-autoscaling:DescribeScalingPolicies", "application-autoscaling:DescribeScheduledActions", "application-autoscaling:PutScalingPolicy", "application-autoscaling:PutScheduledAction", "application-autoscaling:RegisterScalableTarget", "cloudwatch:DeleteAlarms", "cloudwatch:DescribeAlarms", "cloudwatch:PutMetricAlarm", "ec2:AssociateRouteTable", "ec2:AttachInternetGateway", "ec2:AuthorizeSecurityGroupEgress", "ec2:AuthorizeSecurityGroupIngress", "ec2:CreateInternetGateway", "ec2:CreateNetworkInterface", "ec2:CreateRoute", "ec2:CreateRouteTable", "ec2:CreateSecurityGroup", "ec2:CreateSubnet", "ec2:CreateTags", "ec2:CreateVpc", Example policies 728 Amazon WorkSpaces Administration Guide "ec2:DeleteNetworkInterface", "ec2:DeleteSecurityGroup", "ec2:DescribeAvailabilityZones", "ec2:DescribeInternetGateways", "ec2:DescribeNetworkInterfaces", "ec2:DescribeRouteTables", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcs", "ec2:RevokeSecurityGroupEgress", "ec2:RevokeSecurityGroupIngress", "iam:AttachRolePolicy", "iam:CreatePolicy", "iam:CreateRole", "iam:GetRole", "iam:ListRoles", "iam:PutRolePolicy", "kms:ListAliases", "kms:ListKeys", "secretsmanager:ListSecrets", "tag:GetResources", "sso-directory:SearchUsers", "sso:CreateApplication", "sso:DeleteApplication", "sso:DescribeApplication", "sso:DescribeInstance", "sso:GetApplicationGrant", "sso:ListInstances", "sso:PutApplicationAssignment", "sso:PutApplicationAssignmentConfiguration", "sso:PutApplicationAuthenticationMethod", "sso:PutApplicationGrant" ], "Resource": "" }, { "Sid": "iamPassRole", "Effect": "Allow", "Action": "iam:PassRole", "Resource": "", "Condition": { "StringEquals": { "iam:PassedToService": "workspaces.amazonaws.com" } Example policies 729 Amazon WorkSpaces } } ] } Administration Guide Example 2: Grant access to perform WorkSpaces Personal tasks The following policy statement grants an IAM user permission to perform all WorkSpaces Personal tasks. Although Amazon WorkSpaces fully supports the Action and Resource elements when using the API and command line tools, to use Amazon WorkSpaces from the AWS Management Console, an IAM user must have permissions for the following actions and resources: • Actions: "workspaces:" and "ds:" • Resources: "Resource": "" The following example policy shows how to allow an IAM user to use Amazon WorkSpaces from the AWS Management Console. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "workspaces:", "ds:", "iam:GetRole", "iam:CreateRole", "iam:PutRolePolicy", "iam:CreatePolicy", "iam:AttachRolePolicy", "iam:ListRoles", "kms:ListAliases", "kms:ListKeys", "ec2:CreateVpc", "ec2:CreateSubnet", "ec2:CreateNetworkInterface", "ec2:CreateInternetGateway", "ec2:CreateRouteTable", "ec2:CreateRoute", Example policies 730 Amazon WorkSpaces Administration Guide "ec2:CreateTags", "ec2:CreateSecurityGroup", "ec2:DescribeInternetGateways", "ec2:DescribeSecurityGroups", "ec2:DescribeRouteTables", "ec2:DescribeVpcs", "ec2:DescribeSubnets", "ec2:DescribeNetworkInterfaces", "ec2:DescribeAvailabilityZones", "ec2:AttachInternetGateway", "ec2:AssociateRouteTable", "ec2:AuthorizeSecurityGroupEgress", "ec2:AuthorizeSecurityGroupIngress", "ec2:DeleteSecurityGroup", "ec2:DeleteNetworkInterface", "ec2:RevokeSecurityGroupEgress", "ec2:RevokeSecurityGroupIngress", "secretsmanager:ListSecrets", "sso-directory:SearchUsers", "sso:CreateApplication", "sso:DeleteApplication", "sso:DescribeApplication", "sso:DescribeInstance", "sso:GetApplicationGrant", "sso:ListInstances", "sso:PutApplicationAssignment", "sso:PutApplicationAssignmentConfiguration", "sso:PutApplicationAuthenticationMethod", "sso:PutApplicationGrant" ], "Resource": "" }, { "Sid": "iamPassRole", "Effect": "Allow", "Action": "iam:PassRole", "Resource": "", "Condition": { "StringEquals": { "iam:PassedToService": "workspaces.amazonaws.com" } } } ] Example policies 731 Amazon WorkSpaces } Administration Guide Example 3: Grant access to perform WorkSpaces Pools tasks The following policy statement grants an IAM user permission to perform all WorkSpaces Pools tasks. { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": [ "workspaces:", "application-autoscaling:DeleteScalingPolicy", "application-autoscaling:DeleteScheduledAction", "application-autoscaling:DeregisterScalableTarget", "application-autoscaling:DescribeScalableTargets", "application-autoscaling:DescribeScalingActivities", "application-autoscaling:DescribeScalingPolicies", "application-autoscaling:DescribeScheduledActions", "application-autoscaling:PutScalingPolicy", "application-autoscaling:PutScheduledAction", "application-autoscaling:RegisterScalableTarget", "cloudwatch:DeleteAlarms", "cloudwatch:DescribeAlarms", "cloudwatch:PutMetricAlarm", "ec2:CreateSecurityGroup", "ec2:CreateTags", "ec2:DescribeInternetGateways", "ec2:DescribeRouteTables", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcs", "iam:AttachRolePolicy", "iam:CreatePolicy", "iam:CreateRole", "iam:GetRole", "iam:ListRoles", "iam:PutRolePolicy", "secretsmanager:ListSecrets", "tag:GetResources" Example policies 732 Administration Guide Amazon WorkSpaces ], "Resource": "" }, { "Sid": "iamPassRole", "Effect": "Allow", "Action": "iam:PassRole", "Resource": "", "Condition": { "StringEquals": { "iam:PassedToService": "workspaces.amazonaws.com" } } } { "Action": "iam:CreateServiceLinkedRole", "Effect": "Allow", "Resource": "arn:aws:iam:::role/aws-service-role/workspaces.application- autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_WorkSpacesPool", "Condition": { "StringLike": { "iam:AWSServiceName": "workspaces.application- autoscaling.amazonaws.com" } } } ] } Example 4: Perform all WorkSpaces tasks for BYOL WorkSpaces The following policy statement grants an IAM user permission to perform all WorkSpaces tasks, including those Amazon EC2 tasks necessary for creating Bring Your Own License (BYOL) WorkSpaces. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ds:", "workspaces:*", Example policies 733 Amazon WorkSpaces Administration Guide "ec2:AssociateRouteTable",
workspaces-ag-246	workspaces-ag.pdf	246	WorkSpaces ], "Resource": "" }, { "Sid": "iamPassRole", "Effect": "Allow", "Action": "iam:PassRole", "Resource": "", "Condition": { "StringEquals": { "iam:PassedToService": "workspaces.amazonaws.com" } } } { "Action": "iam:CreateServiceLinkedRole", "Effect": "Allow", "Resource": "arn:aws:iam:::role/aws-service-role/workspaces.application- autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_WorkSpacesPool", "Condition": { "StringLike": { "iam:AWSServiceName": "workspaces.application- autoscaling.amazonaws.com" } } } ] } Example 4: Perform all WorkSpaces tasks for BYOL WorkSpaces The following policy statement grants an IAM user permission to perform all WorkSpaces tasks, including those Amazon EC2 tasks necessary for creating Bring Your Own License (BYOL) WorkSpaces. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ds:", "workspaces:", Example policies 733 Amazon WorkSpaces Administration Guide "ec2:AssociateRouteTable", "ec2:AttachInternetGateway", "ec2:AuthorizeSecurityGroupEgress", "ec2:AuthorizeSecurityGroupIngress", "ec2:CreateInternetGateway", "ec2:CreateNetworkInterface", "ec2:CreateRoute", "ec2:CreateRouteTable", "ec2:CreateSecurityGroup", "ec2:CreateSubnet", "ec2:CreateTags", "ec2:CreateVpc", "ec2:DeleteNetworkInterface", "ec2:DeleteSecurityGroup", "ec2:DescribeAvailabilityZones", "ec2:DescribeImages", "ec2:DescribeInternetGateways", "ec2:DescribeNetworkInterfaces", "ec2:DescribeRouteTables", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcs", "ec2:ModifyImageAttribute", "ec2:RevokeSecurityGroupEgress", "ec2:RevokeSecurityGroupIngress", "iam:CreateRole", "iam:GetRole", "iam:PutRolePolicy", "kms:ListAliases", "kms:ListKeys" ], "Resource": "" }, { "Sid": "iamPassRole", "Effect": "Allow", "Action": "iam:PassRole", "Resource": "", "Condition": { "StringEquals": { "iam:PassedToService": "workspaces.amazonaws.com" } } } Example policies 734 Amazon WorkSpaces ] } Administration Guide Specify WorkSpaces resources in an IAM policy To specify an WorkSpaces resource in the Resource element of the policy statement, use the Amazon Resource Name (ARN) of the resource. You control access to your WorkSpaces resources by either allowing or denying permissions to use the API actions that are speciﬁed in the Action element of your IAM policy statement. WorkSpaces deﬁnes ARNs for WorkSpaces, bundles, IP groups, and directories. WorkSpace ARN A WorkSpace ARN has the syntax shown in the following example. arn:aws:workspaces:region:account_id:workspace/workspace_identifier region The Region that the WorkSpace is in (for example, us-east-1). account_id The ID of the AWS account, with no hyphens (for example, 123456789012). workspace_identiﬁer The ID of the WorkSpace (for example, ws-a1bcd2efg). The following is the format of the Resource element of a policy statement that identiﬁes a speciﬁc WorkSpace. "Resource": "arn:aws:workspaces:region:account_id:workspace/workspace_identifier" You can use the wildcard to specify all WorkSpaces that belong to a speciﬁc account in a speciﬁc Region. WorkSpace pool ARN A WorkSpace pool ARN has the syntax shown in the following example. arn:aws:workspaces:region:account_id:workspacespool/workspacespool_identifier Specify WorkSpaces resources in an IAM policy 735 Amazon WorkSpaces region Administration Guide The Region that the WorkSpace is in (for example, us-east-1). account_id The ID of the AWS account, with no hyphens (for example, 123456789012). workspacespool_identiﬁer The ID of the WorkSpace pool (for example, ws-a1bcd2efg). The following is the format of the Resource element of a policy statement that identiﬁes a speciﬁc WorkSpace. "Resource": "arn:aws:workspaces:region:account_id:workspacespool/workspacespool_identifier" You can use the * wildcard to specify all WorkSpaces that belong to a speciﬁc account in a speciﬁc Region. Image ARN A WorkSpace image ARN has the syntax shown in the following example. arn:aws:workspaces:region:account_id:workspaceimage/image_identifier region The Region that the WorkSpace image is in (for example, us-east-1). account_id The ID of the AWS account, with no hyphens (for example, 123456789012). bundle_identiﬁer The ID of the WorkSpace image (for example, wsi-a1bcd2efg). The following is the format of the Resource element of a policy statement that identiﬁes a speciﬁc image. "Resource": "arn:aws:workspaces:region:account_id:workspaceimage/image_identifier" Specify WorkSpaces resources in an IAM policy 736 Amazon WorkSpaces Administration Guide You can use the * wildcard to specify all images that belong to a speciﬁc account in a speciﬁc Region. Bundle ARN A bundle ARN has the syntax shown in the following example. arn:aws:workspaces:region:account_id:workspacebundle/bundle_identifier region The Region that the WorkSpace is in (for example, us-east-1). account_id The ID of the AWS account, with no hyphens (for example, 123456789012). bundle_identiﬁer The ID of the WorkSpace bundle (for example, wsb-a1bcd2efg). The following is the format of the Resource element of a policy statement that identiﬁes a speciﬁc bundle. "Resource": "arn:aws:workspaces:region:account_id:workspacebundle/bundle_identifier" You can use the * wildcard to specify all bundles that belong to a speciﬁc account in a speciﬁc Region. IP Group ARN An IP group ARN has the syntax shown in the following example. arn:aws:workspaces:region:account_id:workspaceipgroup/ipgroup_identifier region The Region that the WorkSpace is in (for example, us-east-1). account_id The ID of the AWS account, with no hyphens (for example, 123456789012). Specify WorkSpaces resources in an IAM policy 737 Amazon WorkSpaces ipgroup_identiﬁer The ID of the IP group (for example, wsipg-a1bcd2efg). Administration Guide The following is the format of the Resource element of a policy statement that identiﬁes a speciﬁc IP group. "Resource": "arn:aws:workspaces:region:account_id:workspaceipgroup/ipgroup_identifier" You can use the * wildcard to specify all IP groups that belong to a speciﬁc account in a speciﬁc Region. Directory ARN A directory ARN has the syntax shown in the following example. arn:aws:workspaces:region:account_id:directory/directory_identifier region The Region that the WorkSpace is in (for example, us-east-1). account_id The ID of the AWS account, with no hyphens (for example, 123456789012). directory_identiﬁer The ID of the directory (for example, d-12345a67b8). The following is the format of the Resource element of a policy statement that identiﬁes a speciﬁc directory. "Resource": "arn:aws:workspaces:region:account_id:directory/directory_identifier" You can use the * wildcard to specify all directories that belong to a speciﬁc account in a speciﬁc Region. Connection
workspaces-ag-247	workspaces-ag.pdf	247	IP groups that belong to a speciﬁc account in a speciﬁc Region. Directory ARN A directory ARN has the syntax shown in the following example. arn:aws:workspaces:region:account_id:directory/directory_identifier region The Region that the WorkSpace is in (for example, us-east-1). account_id The ID of the AWS account, with no hyphens (for example, 123456789012). directory_identiﬁer The ID of the directory (for example, d-12345a67b8). The following is the format of the Resource element of a policy statement that identiﬁes a speciﬁc directory. "Resource": "arn:aws:workspaces:region:account_id:directory/directory_identifier" You can use the * wildcard to specify all directories that belong to a speciﬁc account in a speciﬁc Region. Connection alias ARN A connection alias ARN has the syntax shown in the following example. Specify WorkSpaces resources in an IAM policy 738 Amazon WorkSpaces Administration Guide arn:aws:workspaces:region:account_id:connectionalias/connectionalias_identifier region The Region that the connection alias is in (for example, us-east-1). account_id The ID of the AWS account, with no hyphens (for example, 123456789012). connectionalias_identiﬁer The ID of the connection alias (for example, wsca-12345a67b8). The following is the format of the Resource element of a policy statement that identiﬁes a speciﬁc connection alias. "Resource": "arn:aws:workspaces:region:account_id:connectionalias/connectionalias_identifier" You can use the * wildcard to specify all connection aliases that belong to a speciﬁc account in a speciﬁc Region. API actions with no support for resource-level permissions You can't specify a resource ARN with the following API actions: • AssociateIpGroups • CreateIpGroup • CreateTags • DeleteTags • DeleteWorkspaceImage • DescribeAccount • DescribeAccountModifications • DescribeIpGroups • DescribeTags • DescribeWorkspaceDirectories Specify WorkSpaces resources in an IAM policy 739 Amazon WorkSpaces Administration Guide • DescribeWorkspaceImages • DescribeWorkspaces • DescribeWorkspacesConnectionStatus • DisassociateIpGroups • ImportWorkspaceImage • ListAvailableManagementCidrRanges • ModifyAccount For API actions that don't support resource-level permissions, you must specify the resource statement shown in the following example. "Resource": "" API actions that don't support account-level restrictions on shared resources For the following API actions, you can't specify an account ID in the resource ARN when the resource isn't owned by the account: • AssociateConnectionAlias • CopyWorkspaceImage • DisassociateConnectionAlias For these API actions, you can specify an account ID in the resource ARN only when that account owns the resources to be acted upon. When the account doesn't own the resources, you must specify for the account ID, as shown in the following example. "arn:aws:workspaces:region:*:resource_type/resource_identifier" Create the workspaces_DefaultRole Role Before you can register a directory using the API, you must verify that a role named workspaces_DefaultRole exists. This role is created by the Quick Setup or if you launch a WorkSpace using the AWS Management Console, and it grants Amazon WorkSpaces permission to access speciﬁc AWS resources on your behalf. If this role does not exist, you can create it using the following procedure. Create the workspaces_DefaultRole Role 740 Amazon WorkSpaces Administration Guide To create the workspaces_DefaultRole role 1. Sign in to the AWS Management Console and open the IAM console at https:// console.aws.amazon.com/iam/. 2. In the navigation pane on the left, choose Roles. 3. Choose Create role. 4. Under Select type of trusted entity, choose Another AWS account. 5. 6. For Account ID, enter your account ID with no hyphens or spaces. For Options, do not specify multi-factor authentication (MFA). 7. Choose Next: Permissions. 8. On the Attach permissions policies page, select the AWS managed policies AmazonWorkSpacesServiceAccess, AmazonWorkSpacesSelfServiceAccess, and AmazonWorkSpacesPoolServiceAccess. For more information about these managed policies, see AWS managed policies for WorkSpaces. 9. Under Set permissions boundary, we recommend that you not use a permissions boundary because of the potential for conﬂicts with the policies that are attached to this role. Such conﬂicts could block certain necessary permissions for the role. 10. Choose Next: Tags. 11. On the Add tags (optional) page, add tags if needed. 12. Choose Next: Review. 13. On the Review page, for Role name, enter workspaces_DefaultRole. 14. (Optional) For Role description, enter a description. 15. Choose Create Role. 16. On the Summary page for the workspaces_DefaultRole role, choose the Trust relationships tab. 17. On the Trust relationships tab, choose Edit trust relationship. 18. On the Edit Trust Relationship page, replace the existing policy statement with the following statement. { "Statement": [ { "Effect": "Allow", "Principal": { Create the workspaces_DefaultRole Role 741 Amazon WorkSpaces Administration Guide "Service": "workspaces.amazonaws.com" }, "Action": "sts:AssumeRole" } ] } 19. Choose Update Trust Policy. Create the AmazonWorkSpacesPCAAccess service role Before users can login using certiﬁcate-based authentication, you must verify that a role named AmazonWorkSpacesPCAAccess exists. This role is created when you enable certiﬁcate-based authentication on a Directory using the AWS Management Console, and it grants Amazon WorkSpaces permission to access AWS Private CA resources on your behalf. If this role does not exist because you are not using the console to manage certiﬁcate-based authentication, you can create it using the following procedure. To create the AmazonWorkSpacesPCAAccess service role using the AWS CLI 1. Create a JSON ﬁle named AmazonWorkSpacesPCAAccess.json
workspaces-ag-248	workspaces-ag.pdf	248	19. Choose Update Trust Policy. Create the AmazonWorkSpacesPCAAccess service role Before users can login using certiﬁcate-based authentication, you must verify that a role named AmazonWorkSpacesPCAAccess exists. This role is created when you enable certiﬁcate-based authentication on a Directory using the AWS Management Console, and it grants Amazon WorkSpaces permission to access AWS Private CA resources on your behalf. If this role does not exist because you are not using the console to manage certiﬁcate-based authentication, you can create it using the following procedure. To create the AmazonWorkSpacesPCAAccess service role using the AWS CLI 1. Create a JSON ﬁle named AmazonWorkSpacesPCAAccess.json with the following text. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "prod.euc.ecm.amazonaws.com" }, "Action": "sts:AssumeRole" } ] } 2. Adjust the AmazonWorkSpacesPCAAccess.json path as needed and run the following AWS CLI commands to create the service role and attach the AmazonWorkspacesPCAAccess managed policy. Create the AmazonWorkSpacesPCAAccess service role 742 Amazon WorkSpaces Administration Guide aws iam create-role --path /service-role/ --role-name AmazonWorkSpacesPCAAccess -- assume-role-policy-document file://AmazonWorkSpacesPCAAccess.json aws iam attach-role-policy —role-name AmazonWorkSpacesPCAAccess —policy-arn arn:aws:iam::aws:policy/AmazonWorkspacesPCAAccess AWS managed policies for WorkSpaces Using AWS managed policies makes adding permissions to users, groups, and roles easier than writing policies yourself. It takes time and expertise to create IAM customer managed policies that provide your team with only the permissions they need. Use AWS managed policies to get started quickly. These policies cover common use cases and are available in your AWS account. For more information about AWS managed policies, see AWS managed policies in the IAM User Guide. AWS services maintain and update AWS managed policies. You can't change the permissions in AWS managed policies. Services may occasionally add additional permissions to an AWS managed policy to support new features. This type of update aﬀects all identities (users, groups, and roles) where the policy is attached. Services are most likely to update an AWS managed policy when a new feature is launched or when new operations become available. Services don't remove permissions from an AWS managed policy, so policy updates won't break your existing permissions. Additionally, AWS supports managed policies for job functions that span multiple services. For example, the ReadOnlyAccess AWS managed policy provides read-only access to all AWS services and resources. When a service launches a new feature, AWS adds read-only permissions for new operations and resources. For a list and descriptions of job function policies, see AWS managed policies for job functions in the IAM User Guide. AWS managed policy: AmazonWorkSpacesAdmin This policy provides access to Amazon WorkSpaces administrative actions. It provides the following permissions: • workspaces - Allows access to perform administrative actions on WorkSpaces Personal and WorkSpaces Pools resources. • kms - Allows access to list and describe KMS keys, as well as list aliases. AWS managed policies for WorkSpaces 743 Amazon WorkSpaces Administration Guide { "Version": "2012-10-17", "Statement": [ { "Sid": "AmazonWorkSpacesAdmin", "Effect": "Allow", "Action": [ "kms:DescribeKey", "kms:ListAliases", "kms:ListKeys", "workspaces:CreateTags", "workspaces:CreateWorkspaceImage", "workspaces:CreateWorkspaces", "workspaces:CreateWorkspacesPool", "workspaces:CreateStandbyWorkspaces", "workspaces:DeleteTags", "workspaces:DeregisterWorkspaceDirectory", "workspaces:DescribeTags", "workspaces:DescribeWorkspaceBundles", "workspaces:DescribeWorkspaceDirectories", "workspaces:DescribeWorkspaces", "workspaces:DescribeWorkspacesPools", "workspaces:DescribeWorkspacesPoolSessions", "workspaces:DescribeWorkspacesConnectionStatus", "workspaces:ModifyCertificateBasedAuthProperties", "workspaces:ModifySamlProperties", "workspaces:ModifyStreamingProperties", "workspaces:ModifyWorkspaceCreationProperties", "workspaces:ModifyWorkspaceProperties", "workspaces:RebootWorkspaces", "workspaces:RebuildWorkspaces", "workspaces:RegisterWorkspaceDirectory", "workspaces:RestoreWorkspace", "workspaces:StartWorkspaces", "workspaces:StartWorkspacesPool", "workspaces:StopWorkspaces", "workspaces:StopWorkspacesPool", "workspaces:TerminateWorkspaces", "workspaces:TerminateWorkspacesPool", "workspaces:TerminateWorkspacesPoolSession", "workspaces:UpdateWorkspacesPool" ], "Resource": "" AWS managed policies for WorkSpaces 744 Amazon WorkSpaces } ] } Administration Guide AWS managed policy: AmazonWorkspacesPCAAccess This managed policy provides access to AWS Certiﬁcate Manager Private Certiﬁcate Authority (Private CA) resources in your AWS account for certiﬁcate-based authentication. It is included in the AmazonWorkSpacesPCAAccess role, and it provides the following permissions: • acm-pca - Allows access to AWS Private CA to manage certiﬁcate-based authentication. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "acm-pca:IssueCertificate", "acm-pca:GetCertificate", "acm-pca:DescribeCertificateAuthority" ], "Resource": "arn::acm-pca:::", "Condition": { "StringLike": { "aws:ResourceTag/euc-private-ca": "" } } } ] } AWS managed policy: AmazonWorkSpacesSelfServiceAccess This policy provides access to the Amazon WorkSpaces service to perform WorkSpaces self-service actions initiated by a user. It is included in the workspaces_DefaultRole role, and it provides the following permissions: • workspaces - Allows access to self-service WorkSpaces management capabilities for users. AWS managed policies for WorkSpaces 745 Amazon WorkSpaces Administration Guide { "Version": "2012-10-17", "Statement": [ { "Action": [ "workspaces:RebootWorkspaces", "workspaces:RebuildWorkspaces", "workspaces:ModifyWorkspaceProperties" ], "Effect": "Allow", "Resource": "" } ] } AWS managed policy: AmazonWorkSpacesServiceAccess This policy provides customer account access to the Amazon WorkSpaces service for launching a WorkSpace. It is included in the workspaces_DefaultRole role, and it provides the following permissions: • ec2 - Allows access to manage Amazon EC2 resources associated with a WorkSpace, such as network interfaces. { "Version": "2012-10-17", "Statement": [ { "Action": [ "ec2:CreateNetworkInterface", "ec2:DeleteNetworkInterface", "ec2:DescribeNetworkInterfaces" ], "Effect": "Allow", "Resource": "" } ] } AWS managed policies for WorkSpaces 746 Amazon WorkSpaces Administration Guide AWS managed policy: AmazonWorkSpacesPoolServiceAccess This policy is used in the workspaces_DefaultRole, which WorkSpaces uses to access required resources in the customer AWS account for WorkSpaces Pools. For more information see Create the workspaces_DefaultRole Role. It provides the following
workspaces-ag-249	workspaces-ag.pdf	249	a WorkSpace. It is included in the workspaces_DefaultRole role, and it provides the following permissions: • ec2 - Allows access to manage Amazon EC2 resources associated with a WorkSpace, such as network interfaces. { "Version": "2012-10-17", "Statement": [ { "Action": [ "ec2:CreateNetworkInterface", "ec2:DeleteNetworkInterface", "ec2:DescribeNetworkInterfaces" ], "Effect": "Allow", "Resource": "" } ] } AWS managed policies for WorkSpaces 746 Amazon WorkSpaces Administration Guide AWS managed policy: AmazonWorkSpacesPoolServiceAccess This policy is used in the workspaces_DefaultRole, which WorkSpaces uses to access required resources in the customer AWS account for WorkSpaces Pools. For more information see Create the workspaces_DefaultRole Role. It provides the following permissions: • ec2 - Allows access to manage Amazon EC2 resources associated with a WorkSpaces Pool, such as VPCs, subnets, availability zones, security groups, and route tables. • s3 - Allows access to perform actions on Amazon S3 buckets required for logs, application settings, and the Home Folder feature. Commercial AWS Regions The following policy JSON applies to the commercial AWS Regions. { "Version": "2012-10-17", "Statement": [ { "Sid": "ProvisioningWorkSpacesPoolPermissions", "Effect": "Allow", "Action": [ "ec2:DescribeVpcs", "ec2:DescribeSubnets", "ec2:DescribeAvailabilityZones", "ec2:DescribeSecurityGroups", "ec2:DescribeRouteTables", "s3:ListAllMyBuckets" ], "Resource": "", "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } }, { "Sid": "WorkSpacesPoolS3Permissions", "Effect": "Allow", "Action": [ "s3:CreateBucket", "s3:ListBucket", AWS managed policies for WorkSpaces 747 Amazon WorkSpaces Administration Guide "s3:GetObject", "s3:PutObject", "s3:DeleteObject", "s3:GetObjectVersion", "s3:DeleteObjectVersion", "s3:GetBucketPolicy", "s3:PutBucketPolicy", "s3:PutEncryptionConfiguration" ], "Resource": [ "arn:aws:s3:::wspool-logs-", "arn:aws:s3:::wspool-app-settings-", "arn:aws:s3:::wspool-home-folder-" ], "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } } ] } AWS GovCloud (US) Regions The following policy JSON applies to the commercial AWS GovCloud (US) Regions. { "Version": "2012-10-17", "Statement": [ { "Sid": "ProvisioningWorkSpacesPoolPermissions", "Effect": "Allow", "Action": [ "ec2:DescribeVpcs", "ec2:DescribeSubnets", "ec2:DescribeAvailabilityZones", "ec2:DescribeSecurityGroups", "ec2:DescribeRouteTables", "s3:ListAllMyBuckets" ], "Resource": "", "Condition": { "StringEquals": { AWS managed policies for WorkSpaces 748 Amazon WorkSpaces Administration Guide "aws:ResourceAccount": "${aws:PrincipalAccount}" } } }, { "Sid": "WorkSpacesPoolS3Permissions", "Effect": "Allow", "Action": [ "s3:CreateBucket", "s3:ListBucket", "s3:GetObject", "s3:PutObject", "s3:DeleteObject", "s3:GetObjectVersion", "s3:DeleteObjectVersion", "s3:GetBucketPolicy", "s3:PutBucketPolicy", "s3:PutEncryptionConfiguration" ], "Resource": [ "arn:aws-us-gov:s3:::wspool-logs-", "arn:aws-us-gov:s3:::wspool-app-settings-", "arn:aws-us-gov:s3:::wspool-home-folder-*" ], "Condition": { "StringEquals": { "aws:ResourceAccount": "${aws:PrincipalAccount}" } } } ] } WorkSpaces updates to AWS managed policies View details about updates to AWS managed policies for WorkSpaces since this service began tracking these changes. AWS managed policies for WorkSpaces 749 Amazon WorkSpaces Administration Guide Change Description Date the section called “AmazonWorkSpacesP WorkSpaces added a new managed policy to grant oolServiceAcces” - Added new permission to view Amazon June 24, 2024 policy EC2 VPCs and related resources, and to view and manage Amazon S3 buckets for WorkSpaces Pools. the section called “AmazonWorkSpacesAdmin” - WorkSpaces added several actions for WorkSpaces Pools June 24, 2024 Updated policy the section called “AmazonWorkSpacesAdmin” - Updated policy the section called “AmazonWorkspacesP CAAccess” - Added new policy WorkSpaces started tracking changes to the Amazon WorkSpace sAdmin managed policy, granting admins access to manage WorkSpace Pool resources. WorkSpaces added the June 25, 2023 workspaces:Restore Workspace action to the Amazon WorkSpacesAdmin managed policy, granting admins access to restore WorkSpaces. WorkSpaces added a new managed policy to grant acm-pca permission to manage AWS Private CA to manage certiﬁcate-based authentication. WorkSpaces started tracking changes for its WorkSpaces managed policies. November 18, 2022 March 1, 2021 AWS managed policies for WorkSpaces 750 Amazon WorkSpaces Administration Guide Access to WorkSpaces and scripts on streaming instances Applications and scripts that run on WorkSpaces streaming instances must include AWS credentials in their AWS API requests. You can create an IAM role to manage these credentials. An IAM role speciﬁes a set of permissions that you can use to access AWS resources. This role is not uniquely associated with one person, however. Instead, it can be assumed by anyone that needs it. You can apply an IAM role to a WorkSpaces streaming instance. When the streaming instance switches to (assumes) the role, the role provides temporary security credentials. Your application or scripts use these credentials to perform API actions and management tasks on the streaming instance. WorkSpaces manages the temporary credential switch for you. Contents • Best Practices for Using IAM Roles With WorkSpaces Streaming Instances • Conﬁguring an Existing IAM Role to Use With WorkSpaces Streaming Instances • How to Create an IAM Role to Use With WorkSpaces Streaming Instances • How to Use the IAM Role With WorkSpaces Streaming Instances Best Practices for Using IAM Roles With WorkSpaces Streaming Instances When you use IAM roles with WorkSpaces streaming instances, we recommend that you follow these practices: • Limit the permissions that you grant to AWS API actions and resources. Follow least privilege principles when you create and attach IAM policies to the IAM roles associated with WorkSpaces streaming instances. When you use an application or script that requires access to AWS API actions or resources, determine the speciﬁc actions and resources that are required. Then, create policies that allow the application or script to perform only those actions. For more information, see Grant Least Privilege in the
workspaces-ag-250	workspaces-ag.pdf	250	WorkSpaces Streaming Instances When you use IAM roles with WorkSpaces streaming instances, we recommend that you follow these practices: • Limit the permissions that you grant to AWS API actions and resources. Follow least privilege principles when you create and attach IAM policies to the IAM roles associated with WorkSpaces streaming instances. When you use an application or script that requires access to AWS API actions or resources, determine the speciﬁc actions and resources that are required. Then, create policies that allow the application or script to perform only those actions. For more information, see Grant Least Privilege in the IAM User Guide. • Create an IAM role for each WorkSpaces resource. Creating a unique IAM role for each WorkSpaces resource is a practice that follows least privilege principles. Doing so also lets you modify permissions for a resource without aﬀecting other resources. • Limit where the credentials can be used. Access to WorkSpaces and scripts on streaming instances 751 Amazon WorkSpaces Administration Guide IAM policies let you deﬁne the conditions under which your IAM role can be used to access a resource. For example, you can include conditions to specify a range of IP addresses that requests can come from. Doing so prevents the credentials from being used outside of your environment. For more information, see Use Policy Conditions for Extra Security in the IAM User Guide. Conﬁguring an Existing IAM Role to Use With WorkSpaces Streaming Instances This topic describes how to conﬁgure an existing IAM role so that you can use it with WorkSpaces . Prerequisites The IAM role that you want to use with WorkSpaces must meet the following prerequisites: • The IAM role must be in the same Amazon Web Services account as the WorkSpaces streaming instance. • The IAM role cannot be a service role. • The trust relationship policy that is attached to the IAM role must include the WorkSpaces service as the principal. A principal is an entity in AWS that can perform actions and access resources. The policy must also include the sts:AssumeRole action. This policy conﬁguration deﬁnes WorkSpaces as a trusted entity. • If you are applying the IAM role to WorkSpaces, the WorkSpaces must run a version of the WorkSpaces agent released on or after September 3, 2019. If you are applying the IAM role to WorkSpaces, the WorkSpaces must use an image that uses a version of the agent released on or after the same date. To enable the WorkSpaces service principal to assume an existing IAM role To perform the following steps, you must sign into the account as an IAM user who has the permissions required to list and update IAM roles. If you don't have the required permissions, ask your Amazon Web Services account administrator either to perform these steps in your account or to grant you the required permissions. 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. 3. In the navigation pane, choose Roles. In the list of roles in your account, choose the name of the role that you want to modify. Access to WorkSpaces and scripts on streaming instances 752 Amazon WorkSpaces Administration Guide 4. Choose the Trust relationships tab, and then choose Edit trust relationship. 5. Under Policy Document, verify that the trust relationship policy includes the sts:AssumeRole action for the workspaces.amazonaws.com service principal: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": [ "workspaces.amazonaws.com" ] }, "Action": "sts:AssumeRole" } ] } 6. When you are ﬁnished editing your trust policy, choose Update Trust Policy to save your changes. 7. The IAM role that you selected will display in the WorkSpaces console. This role grants permissions to applications and scripts to perform API actions and management tasks on streaming instances. How to Create an IAM Role to Use With WorkSpaces Streaming Instances This topic describes how to create a new IAM role so that you can use it with WorkSpaces 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. 3. 4. In the navigation pane, choose Roles, and then choose Create role. For Select type of trusted entity, choose AWS service. From the list of AWS services, choose WorkSpaces. 5. Under Select your use case, WorkSpaces — Allows WorkSpaces instances to call AWS services on your behalf is already selected. Choose Next: Permissions. 6. If possible, select the policy to use for the permissions policy or choose Create policy to open a new browser tab and create a new policy from scratch. For more information, see step 4 in the procedure Creating IAM Policies (Console) in the IAM User Guide. Access to WorkSpaces and scripts on streaming instances 753 Amazon WorkSpaces Administration Guide After you create the policy, close that tab and return to your original tab. Select the check box next to the permissions policies that you want WorkSpaces
workspaces-ag-251	workspaces-ag.pdf	251	to call AWS services on your behalf is already selected. Choose Next: Permissions. 6. If possible, select the policy to use for the permissions policy or choose Create policy to open a new browser tab and create a new policy from scratch. For more information, see step 4 in the procedure Creating IAM Policies (Console) in the IAM User Guide. Access to WorkSpaces and scripts on streaming instances 753 Amazon WorkSpaces Administration Guide After you create the policy, close that tab and return to your original tab. Select the check box next to the permissions policies that you want WorkSpaces to have. 7. (Optional) Set a permissions boundary. This is an advanced feature that is available for service roles, but not service-linked roles. For more information, see Permissions Boundaries for IAM Entities in the IAM User Guide. 8. Choose Next: Tags. You can optionally attach tags as key-value pairs. For more information, see Tagging IAM Users and Roles in the IAM User Guide. 9. Choose Next: Review. 10. For Role name, type a role name that is unique within your Amazon Web Services account. Because other AWS resources might reference the role, you can't edit the name of the role after it has been created. 11. For Role description, keep the default role description or type a new one. 12. Review the role, and then choose Create role. How to Use the IAM Role With WorkSpaces Streaming Instances After you create an IAM role, you can apply it to WorkSpaces when you launch WorkSpaces. You can also apply an IAM role to existing WorkSpaces. When you apply an IAM role to WorkSpaces, WorkSpaces retrieves temporary credentials and creates the workspaces_machine_role credential proﬁle on the instance. The temporary credentials are valid for 1 hour, and new credentials retrieved every hour. The previous credentials do not expire, so you can use them for as long as they are valid. You can use the credential proﬁle to call AWS services programmatically by using the AWS Command Line Interface (AWS CLI), AWS Tools for PowerShell, or the AWS SDK with the language of your choice. When you make the API calls, specify workspaces_machine_role as the credential proﬁle. Otherwise, the operation fails due to insuﬃcient permissions. WorkSpaces assumes the speciﬁed role while the streaming instance is provisioned. Because WorkSpaces uses the elastic network interface that is attached to your VPC for AWS API calls, your application or script must wait for the elastic network interface to become available before making AWS API calls. If API calls are made before the elastic network interface is available, the calls fail. Access to WorkSpaces and scripts on streaming instances 754 Amazon WorkSpaces Administration Guide The following examples show how you can use the workspaces_machine_role credential proﬁle to describe streaming instances (EC2 instances) and to create the Boto client. Boto is the Amazon Web Services (AWS) SDK for Python. Describe Streaming Instances (EC2 instances) by Using the AWS CLI aws ec2 describe-instances --region us-east-1 --profile workspaces_machine_role Describe Streaming Instances (EC2 instances) by Using AWS Tools for PowerShell You must use AWS Tools for PowerShell version 3.3.563.1 or later, with the Amazon Web Services SDK for .NET version 3.3.103.22 or later. You can download the AWS Tools for Windows installer, which includes AWS Tools for PowerShell and the Amazon Web Services SDK for .NET, from the AWS Tools for PowerShell website. Get-EC2Instance -Region us-east-1 -ProfileName workspaces_machine_role Creating the Boto Client by Using the AWS SDK for Python session = boto3.Session(profile_name=workspaces_machine_role') Compliance validation for Amazon WorkSpaces Third-party auditors assess the security and compliance of Amazon WorkSpaces as part of multiple AWS compliance programs. These include SOC, PCI, FedRAMP, HIPAA, and others. For a list of AWS services in scope of speciﬁc compliance programs, see AWS Services in Scope by Compliance Program. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. For more information about WorkSpaces and FedRAMP, see Conﬁgure FedRAMP authorization or DoD SRG compliance for WorkSpaces Personal. Your compliance responsibility when using WorkSpaces is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: Compliance validation 755 Amazon WorkSpaces Administration Guide • Security and Compliance Quick Start Guides – These deployment guides discuss architectural considerations and provide steps for deploying security- and compliance-focused baseline environments on AWS. • Architecting for HIPAA Security and Compliance on Amazon Web Services – This whitepaper describes how companies can use AWS to create HIPAA-compliant applications. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • Evaluating Resources with Rules in the AWS Conﬁg Developer Guide – AWS Conﬁg; assesses how well your resource conﬁgurations
workspaces-ag-252	workspaces-ag.pdf	252	resources to help with compliance: Compliance validation 755 Amazon WorkSpaces Administration Guide • Security and Compliance Quick Start Guides – These deployment guides discuss architectural considerations and provide steps for deploying security- and compliance-focused baseline environments on AWS. • Architecting for HIPAA Security and Compliance on Amazon Web Services – This whitepaper describes how companies can use AWS to create HIPAA-compliant applications. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • Evaluating Resources with Rules in the AWS Conﬁg Developer Guide – AWS Conﬁg; assesses how well your resource conﬁgurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS that helps you check your compliance with security industry standards and best practices. Resilience in Amazon WorkSpaces The AWS global infrastructure is built around AWS Regions and Availability Zones. Regions provide multiple physically separated and isolated Availability Zones, which are connected through low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between 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. Amazon WorkSpaces also provides cross-Region redirection, a feature that works with your Domain Name System (DNS) failover routing policies to redirect your WorkSpaces users to alternative WorkSpaces in another AWS Region when their primary WorkSpaces aren't available. For more information, see Cross-Region redirection for WorkSpaces Personal. Infrastructure security in Amazon WorkSpaces As a managed service, Amazon WorkSpaces is protected by AWS global network security. For information about AWS security services and how AWS protects infrastructure, see AWS Cloud Security. To design your AWS environment using the best practices for infrastructure security, see Infrastructure Protection in Security Pillar AWS Well‐Architected Framework. Resilience 756 Amazon WorkSpaces Administration Guide You use AWS published API calls to access WorkSpaces through the network. Clients must support the following: • Transport Layer Security (TLS). We require TLS 1.2 and recommend TLS 1.3. • Cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diﬃe-Hellman) or ECDHE (Elliptic Curve Ephemeral Diﬃe-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Network isolation A virtual private cloud (VPC) is a virtual network in your own logically isolated area in the AWS Cloud. You can deploy your WorkSpaces in a private subnet in your VPC. For more information, see Conﬁgure a VPC for WorkSpaces Personal. To allow traﬃc only from speciﬁc address ranges (for example, from your corporate network), update the security group for your VPC or use an IP access control group. You can restrict WorkSpace access to trusted devices with valid certiﬁcates. For more information, see Restrict access to trusted devices for WorkSpaces Personal. Isolation on physical hosts Diﬀerent WorkSpaces on the same physical host are isolated from each other through the hypervisor. It is as though they are on separate physical hosts. When a WorkSpace is deleted, the memory allocated to it is scrubbed (set to zero) by the hypervisor before it is allocated to a new WorkSpace. Authorization of corporate users With WorkSpaces, directories are managed through the AWS Directory Service. You can create a standalone, managed directory for users. Or you can integrate with your existing Active Directory environment so that your users can use their current credentials to obtain seamless access to corporate resources. For more information, see Manage directories for WorkSpaces Personal. Network isolation 757 Amazon WorkSpaces Administration Guide To further control access to your WorkSpaces, use multi-factor authentication. For more information, see How to Enable Multi-Factor Authentication for AWS Services. Make Amazon WorkSpaces API requests through a VPC interface endpoint You can connect directly to Amazon WorkSpaces API endpoints through an interface endpoint in your virtual private cloud (VPC) instead of connecting over the internet. When you use a VPC interface endpoint, communication between your VPC and the Amazon WorkSpaces API endpoint is conducted entirely and securely within the AWS network. Note This feature can be used only for connecting to WorkSpaces API endpoints. To connect to WorkSpaces using the WorkSpaces clients, internet connectivity is required, as described in IP address and port requirements for WorkSpaces Personal. The Amazon WorkSpaces API endpoints support Amazon Virtual Private Cloud (Amazon VPC) interface endpoints that are powered by AWS PrivateLink. Each VPC endpoint is represented by one or more network interfaces (also known as
workspaces-ag-253	workspaces-ag.pdf	253	connecting over the internet. When you use a VPC interface endpoint, communication between your VPC and the Amazon WorkSpaces API endpoint is conducted entirely and securely within the AWS network. Note This feature can be used only for connecting to WorkSpaces API endpoints. To connect to WorkSpaces using the WorkSpaces clients, internet connectivity is required, as described in IP address and port requirements for WorkSpaces Personal. The Amazon WorkSpaces API endpoints support Amazon Virtual Private Cloud (Amazon VPC) interface endpoints that are powered by AWS PrivateLink. Each VPC endpoint is represented by one or more network interfaces (also known as elastic network interfaces, or ENIs) with private IP addresses in your VPC subnets. The VPC interface endpoint connects your VPC directly to the Amazon WorkSpaces API endpoint without an internet gateway, NAT device, VPN connection, or AWS Direct Connect connection. The instances in your VPC don't need public IP addresses to communicate with the Amazon WorkSpaces API endpoint. You can create an interface endpoint to connect to Amazon WorkSpaces with either the AWS Management Console or AWS Command Line Interface (AWS CLI) commands. For instructions, see Creating an Interface Endpoint. After you have created a VPC endpoint, you can use the following example CLI commands that use the endpoint-url parameter to specify interface endpoints to the Amazon WorkSpaces API endpoint: aws workspaces copy-workspace-image --endpoint- url VPC_Endpoint_ID.workspaces.Region.vpce.amazonaws.com Make Amazon WorkSpaces API requests through a VPC interface endpoint 758 Amazon WorkSpaces Administration Guide aws workspaces delete-workspace-image --endpoint- url VPC_Endpoint_ID.api.workspaces.Region.vpce.amazonaws.com aws workspaces describe-workspace-bundles --endpoint- url VPC_Endpoint_ID.workspaces.Region.vpce.amazonaws.com \ --endpoint-name Endpoint_Name \ --body "Endpoint_Body" \ --content-type "Content_Type" \ Output_File If you enable private DNS hostnames for your VPC endpoint, you don't need to specify the endpoint URL. The Amazon WorkSpaces API DNS hostname that the CLI and Amazon WorkSpaces SDK use by default (https://api.workspaces.Region.amazonaws.com) resolves to your VPC endpoint. The Amazon WorkSpaces API endpoint supports VPC endpoints in all AWS Regions where both Amazon VPC and Amazon WorkSpaces are available. Amazon WorkSpaces supports making calls to all of its public APIs inside your VPC. To learn more about AWS PrivateLink, see the AWS PrivateLink documentation. For the price of VPC endpoints, see VPC Pricing. To learn more about VPC and endpoints, see Amazon VPC. To see a list of Amazon WorkSpaces API endpoints by Region, see WorkSpaces API Endpoints. Note Amazon WorkSpaces API endpoints with AWS PrivateLink are not supported for Federal Information Processing Standard (FIPS) Amazon WorkSpaces API endpoints. Create a VPC endpoint policy for Amazon WorkSpaces You can create a policy for Amazon VPC endpoints for Amazon WorkSpaces to specify the following: • The principal that can perform actions. • The actions that can be performed. • The resources on which actions can be performed. Create a VPC endpoint policy for Amazon WorkSpaces 759 Amazon WorkSpaces Administration Guide For more information, see Controlling Access to Services with VPC Endpoints in the Amazon VPC User Guide. Note VPC endpoint policies aren't supported for Federal Information Processing Standard (FIPS) Amazon WorkSpaces endpoints. The following example VPC endpoint policy speciﬁes that all users who have access to the VPC interface endpoint are allowed to invoke the Amazon WorkSpaces hosted endpoint named ws- f9abcdefg. { "Statement": [ { "Action": "workspaces:", "Effect": "Allow", "Resource": "arn:aws:workspaces:us-west-2:1234567891011:workspace/ws- f9abcdefg", "Principal": "" } ] } In this example, the following actions are denied: • Invoking Amazon WorkSpaces hosted endpoints other than ws-f9abcdefg. • Performing an action on any resource besides the one speciﬁed (WorkSpace ID: ws-f9abcdefg). Note In this example, users can still take other Amazon WorkSpaces API actions from outside the VPC. To restrict API calls to those from within the VPC, see Identity and access management for WorkSpaces for information about using identity-based policies to control access to Amazon WorkSpaces API endpoints. Create a VPC endpoint policy for Amazon WorkSpaces 760 Amazon WorkSpaces Administration Guide Connect your private network to your VPC To call the Amazon WorkSpaces API through your VPC, you have to connect from an instance that is inside the VPC, or connect your private network to your VPC by using AWS Virtual Private Network (AWS VPN) or AWS Direct Connect. For information, see VPN Connections in the Amazon Virtual Private Cloud User Guide. For information about AWS Direct Connect, see Creating a Connection in the AWS Direct Connect User Guide. Update management in WorkSpaces We recommend that you regularly patch, update, and secure the operating system and applications on your WorkSpaces. You can conﬁgure your WorkSpaces to be updated by WorkSpaces during a regular maintenance window or you can update them yourself. For more information, see Maintenance in WorkSpaces Personal. For applications on your WorkSpaces, you can use any automatic update services provided or follow the recommendations for installing updates provided by the application vendor. Connect your private network to your VPC 761 Amazon WorkSpaces Administration Guide
workspaces-ag-254	workspaces-ag.pdf	254	Direct Connect, see Creating a Connection in the AWS Direct Connect User Guide. Update management in WorkSpaces We recommend that you regularly patch, update, and secure the operating system and applications on your WorkSpaces. You can conﬁgure your WorkSpaces to be updated by WorkSpaces during a regular maintenance window or you can update them yourself. For more information, see Maintenance in WorkSpaces Personal. For applications on your WorkSpaces, you can use any automatic update services provided or follow the recommendations for installing updates provided by the application vendor. Connect your private network to your VPC 761 Amazon WorkSpaces Administration Guide Amazon WorkSpaces quotas Amazon WorkSpaces provides diﬀerent resources that you can use in your account in a given Region, including WorkSpaces, images, bundles, directories, connection aliases, and IP control groups. When you create your Amazon Web Services account, we set default quotas (also referred to as limits) on the number of resources that you can create. The following are the default quotas for WorkSpaces for your AWS account. You can use the Service Quotas console to view the default quota and applied quota, or to request quota increases for adjustable quotas. In some Regions, where Service Quotas is not available, you must submit a support case to request limit increase. For more information, see Viewing service quotas and Requesting a quota increase in the Service Quotas User Guide. Resource Default Description Adjustable WorkSpaces 1 Graphics WorkSpaces 0 Yes Yes The maximum number of WorkSpaces in this account in the current Region. The maximum number of Graphics WorkSpaces in this account in the current Region. Note Graphics bundle is no longer supported after November 762 Amazon WorkSpaces Administration Guide Resource Default Description Adjustable 30, 2023. We recommend migrating your WorkSpaces to Graphics. g4dn bundle. For more information, see Migrate a WorkSpace in WorkSpaces Personal. The maximum number of GeneralPu Yes rpose.4xlarge WorkSpaces in this account in the current Region. The maximum number of GeneralPu Yes rpose.8xlarge WorkSpaces in this account in the current Region. Yes The maximum number of Graphics. g4dn WorkSpaces in this account in the current Region. 763 GeneralPurpose.4xl arge WorkSpaces GeneralPurpose.8xl arge WorkSpaces Graphics.g4dn WorkSpaces 1 1 0 Amazon WorkSpaces Administration Guide Resource Default Description Adjustable GraphicsPro WorkSpaces 0 The maximum number of GraphicsP Yes GraphicsPro.g4dn WorkSpaces 0 Standby WorkSpaces 5 Bundles 50 ro WorkSpaces in this account in the current Region. (GraphicsPro bundle reaches end-of-life on October 31, 2025. Consider using other supported bundles as a replacement.) The maximum number of GraphicsP ro.g4dn WorkSpaces in this account in the current Region. The maximum number of WorkSpaces in this account in the current Region. The maximum number of bundles in this account in the current Region. This quota applies only to custom bundles, not to public bundles. Yes Yes No 764 Amazon WorkSpaces Administration Guide Resource Default Description Adjustable Connection aliases 20 Directories 50 Images 40 IP access control groups 100 IP access control groups per directory 25 The maximum number of connectio No n aliases in this account in the current Region. The maximum number of directories No that can be registered for use with Amazon WorkSpaces in this account in the current Region. Yes The maximum number of images in this account in the current Region. The maximum number of IP access No control groups in this account in the current Region. No The maximum number of IP access control groups per directory in this account in the current Region. 765 Amazon WorkSpaces Administration Guide Resource Default Description Adjustable Rules per IP access control group 10 WorkSpaces Pools 10 10 General Purpose Value streaming instances for WorkSpaces Pools General Purpose Standard streaming 10 instances for WorkSpaces Pools No Yes Yes Yes The maximum number of rules per IP access control group in this account in the current Region. The maximum number of WorkSpaces Pools in this account in the current Region. The maximum number of General Purpose Value streaming instances that can be used for WorkSpaces Pools in this account in the current Region. The maximum number of General Purpose Standard instances that can be used for WorkSpaces Pools in this account in the current Region. 766 Amazon WorkSpaces Administration Guide Resource Default Description Adjustable 10 General Purpose Performance streaming instances for WorkSpaces Pools 10 General Purpose Power streaming instances for WorkSpaces Pools" General Purpose PowerPro streaming 10 instances for WorkSpaces Pools" Graphics.g4dn xlarge streaming instances for WorkSpaces Pools 0 Yes Yes Yes Yes The maximum number of General Purpose Performance streaming instances that can be used for WorkSpaces Pools in this account in the current Region. The maximum number of General Purpose Power streaming instances that can be used for WorkSpaces Pools in this account in the current Region. The maximum number of General Purpose PowerPro streaming instances that can be used for WorkSpaces Pools
workspaces-ag-255	workspaces-ag.pdf	255	General Purpose Performance streaming instances for WorkSpaces Pools 10 General Purpose Power streaming instances for WorkSpaces Pools" General Purpose PowerPro streaming 10 instances for WorkSpaces Pools" Graphics.g4dn xlarge streaming instances for WorkSpaces Pools 0 Yes Yes Yes Yes The maximum number of General Purpose Performance streaming instances that can be used for WorkSpaces Pools in this account in the current Region. The maximum number of General Purpose Power streaming instances that can be used for WorkSpaces Pools in this account in the current Region. The maximum number of General Purpose PowerPro streaming instances that can be used for WorkSpaces Pools in this account in the current Region. The maximum number of Graphics. g4dn xlarge streaming instances that can be used for WorkSpaces Pools in this account in the current Region. 767 Amazon WorkSpaces Administration Guide Resource Default Description Adjustable 0 Graphics.g4dn 4xlarge streaming instances for WorkSpaces Pools The maximum number of Graphics. Yes g4dn 4xlarge streaming instances that can be used for WorkSpaces Pools in this account in the current Region. API throttling The allowed rate is two calls per second. For more information, see Throttling exceptions. 768 Amazon WorkSpaces Administration Guide End of life policy for WorkSpaces client applications The Amazon WorkSpaces end of life (EOL) policy is applicable to speciﬁc major versions (and all of their minor versions) of WorkSpaces clients for WorkSpaces Personal and WorkSpaces Pools. The lifecycle of a WorkSpaces client version has three phases—general support, technical guidance, and end of life (EOL). The general support phase begins on the date of initial public release of a WorkSpaces client and lasts for a ﬁxed duration. During the general support phase, the WorkSpaces support team provides full support for conﬁguration issues. Defect resolutions and feature requests are implemented for that major version and the associated minor versions of the WorkSpaces client. Technical guidance is provided from the end of the general support phase until the EOL date. During the technical guidance phase, you receive support and guidance for supported conﬁgurations only. Defect resolutions and feature requests are implemented for the most recent versions of the WorkSpaces client only. They are not implemented for older versions. During the technical guidance phase, if a ﬁx is required, AWS will schedule that ﬁx for the upcoming publicly available version release, and you will have the option to upgrade to the latest WorkSpaces version to receive support related to the ﬁx. EOL for a major version occurs when both general support and technical guidance have ended. After the EOL date, no further support or maintenance is provided. AWS stops testing for compatibility issues. For continued support, you must upgrade to the latest WorkSpaces client version. Refer to this table for more information about support for speciﬁc versions. Important Support for the following versions will end by March 31, 2025. Make sure you upgrade to a supported client version before they reach EOL to avoid disruption of service. • Windows 3.x, 4.x, and 5.0-5.22.0 • Linux 4.x, 2023.x, and 2024.0-2024.5 for Ubuntu 20.04 • Linux 2023.x and 2024.0-2024.5 for Ubuntu 22.04 • macOS 3.x, 4.x, and 5.1-5.22.0 • Android 3.x, 4.x, and 5.0.0 769 Amazon WorkSpaces Administration Guide Windows client General support Technical guidance EOL Notes 5.22.1+ September 3, 2024 5.0-5.22.0 June 2, 2022 November 21, 2024 March 31, 2025 4.x June 30, 2021 November 21, 2024 March 31, 2025 3.x November 25, 2019 November 21, 2024 March 31, 2025 Supported Make sure you upgrade to the latest client version before this version reaches its EOL date. Make sure you upgrade to the latest client version before this version reaches its EOL date. Make sure you upgrade to the latest client version before this version reaches its EOL date. Linux client General support Technical guidance EOL Notes 2024.6+ for Ubuntu 22.04 September 6, 2024 Supported 770 Amazon WorkSpaces Administration Guide Linux client General support Technical guidance EOL Notes 2024.6+ for Ubuntu 20.04 September 6, 2024 2024.0-2024.5 for Ubuntu February 28, 2024 November 21, 2024 March 31, 2025 22.04 2024.0-2024.5 for Ubuntu 20.04 August 24, 2023 November 21, 2024 March 31, 2025 2023.x for Ubuntu 22.04 August 24, 2023 November 21, 2024 March 31, 2025 2023.x for Ubuntu 20.04 August 24, 2023 November 21, 2024 March 31, 2025 Supported Make sure you upgrade to the latest client version before this version reaches its EOL date. Make sure you upgrade to the latest client version before this version reaches its EOL date. Make sure you upgrade to the latest client version before this version reaches its EOL date. Make sure you upgrade to the latest client version before this version reaches its EOL date. 771 Amazon WorkSpaces Administration Guide Linux client General support Technical guidance EOL Notes 4.x for Ubuntu 20.04 October 27, 2022 November 21, 2024 March 31, 2025 Make sure you upgrade
workspaces-ag-256	workspaces-ag.pdf	256	21, 2024 March 31, 2025 Supported Make sure you upgrade to the latest client version before this version reaches its EOL date. Make sure you upgrade to the latest client version before this version reaches its EOL date. Make sure you upgrade to the latest client version before this version reaches its EOL date. Make sure you upgrade to the latest client version before this version reaches its EOL date. 771 Amazon WorkSpaces Administration Guide Linux client General support Technical guidance EOL Notes 4.x for Ubuntu 20.04 October 27, 2022 November 21, 2024 March 31, 2025 Make sure you upgrade to the latest client version before this version reaches its EOL date. macOS client General support Technical guidance EOL Notes 5.22.1+ September 3, 2024 5.1-5.22.0 June 30, 2022 November 21, 2024 March 31, 2025 4.x August 5, 2021 November 21, 2024 March 31, 2025 3.x November 25, 2019 November 21, 2024 March 31, 2025 Supported Make sure you upgrade to the latest client version before this version reaches its EOL date. Make sure you upgrade to the latest client version before this version reaches its EOL date. Make sure you upgrade to the latest client 772 Amazon WorkSpaces Administration Guide macOS client General support Technical guidance EOL Notes version before this version reaches its EOL date. iPad client General support Technical guidance EOL Notes 2.x 2019 Supported Android client General support Technical guidance EOL Notes 5.0.1+ 5.0.0 November 6, 2024 February 26, 2024 November 21, 2024 March 31, 2025 4.x May 12, 2022 November 21, 2024 March 31, 2025 Supported Make sure you upgrade to the latest client version before this version reaches its EOL date. Make sure you upgrade to the latest client version before this version reaches its EOL date. 773 Amazon WorkSpaces Administration Guide Android client General support 3.x June 30, 2021 Technical guidance November 21, 2024 EOL Notes March 31, 2025 Make sure you upgrade to the latest client version before this version reaches its EOL date. Web access Google Chrome Firefox Microsoft Edge General support Current version, plus two most recent major versions Current version, plus two most recent major versions Current version, plus two most recent major versions Unsupported client versions The following WorkSpaces clients are not supported. Operating system Client version General support Technical guidance EOL Notes Windows 5.11 July 3, 2023 October 1, 2023 October 1, 2023 Not supported Windows 5.10 June 19, 2023 October 1, 2023 October 1, 2023 Not supported Unsupported client versions 774 Amazon WorkSpaces Administration Guide Operating system Client version General support Technical guidance EOL Notes Windows 5.9 May 9, 2023 Windows 2.x 2018 October 1, 2023 October 1, 2023 Not supported March 31, 2023 August 31, 2023 Not supported August 12, 2021 March 31, 2023 August 31, 2023 Not supported November 25, 2019 March 31, 2023 August 31, 2023 Not supported Ubuntu Ubuntu macOS macOS iPad 4.x for Ubuntu 18.04 3.x for Ubuntu 18.04 2.x 1.x 1.x 2019 2018 2018 Android 2.x 2019 Android 1.x 2018 March 31, 2023 August 31, 2023 Not supported March 31, 2023 August 31, 2023 Not supported March 31, 2023 August 31, 2023 Not supported March 31, 2023 August 31, 2023 Not supported March 31, 2023 August 31, 2023 Not supported Unsupported client versions 775 Amazon WorkSpaces EOL FAQs Administration Guide I’m using a version of a WorkSpaces client that has reached its EOL. What should I do to upgrade to a supported version? Go to the WorkSpaces client download page to download and install a fully supported version of WorkSpaces. Can I use a version of the WorkSpaces client that has reached its EOL with a supported WorkSpace? We strongly recommend upgrading your clients to the latest version as previous resolutions and features are no longer applied to clients versions that have reached their EOL. If you are using a client version that has reached its EOL, contact the AWS support team for more information. I’m using a version of a WorkSpaces client that has reached its EOL. Can I still report issues for it? You must ﬁrst upgrade to a supported version and try to reproduce the issue. If the issue persists in the supported version, open a support case with the AWS support team. I'm using a supported WorkSpaces client version on an operating system that has reached its EOL. Can I still report issues for it? Technical assistance and software updates are no longer available for operating systems that have reached EOL and AWS doesn't provide support to WorkSpaces clients that use operating systems that have reached its EOL. Use a supported operating system to ensure you have support for your WorkSpaces clients. EOL FAQs 776 Amazon WorkSpaces Administration Guide SDK extension supported by DCV DCV enables high-performance remote access to WorkSpaces instances for a wide range of
workspaces-ag-257	workspaces-ag.pdf	257	with the AWS support team. I'm using a supported WorkSpaces client version on an operating system that has reached its EOL. Can I still report issues for it? Technical assistance and software updates are no longer available for operating systems that have reached EOL and AWS doesn't provide support to WorkSpaces clients that use operating systems that have reached its EOL. Use a supported operating system to ensure you have support for your WorkSpaces clients. EOL FAQs 776 Amazon WorkSpaces Administration Guide SDK extension supported by DCV DCV enables high-performance remote access to WorkSpaces instances for a wide range of workloads and use cases. With the Amazon DCV Extension SDK, developers can customize DCV WorkSpaces experience for end users, including: • Facilitating custom hardware support. • Enhancing the usability of third-party applications in remote sessions. For example, adding local audio termination for VoIP applications or local video playback for conferencing applications • Providing accessibility software like screen readers with information about the remote session and applications running remotely. • Allowing security software to analyze the security posture of the local endpoint to allow conditional access policies. • Performing arbitrary data transfers over an established remote session. To get started with Amazon DCV Extension SDK, see Amazon DCV Extension SDK documentation. You can ﬁnd the SDK itself at Amazon DCV Extension SDK GitHub repository. In addition, you can also ﬁnd integration examples of SDK at Amazon DCV Extension SDK samples GitHub repository. The following are supported by WorkSpaces. • Streaming protocol – DCV • WorkSpaces Windows client – Windows: 5.9.0.4110 and above. Note WorkSpaces Android, iOS clients, web access does not support DCV Extension SDK. • WorkSpaces supported – Windows, Linux, and Ubuntu servers 777 Amazon WorkSpaces Administration Guide Document history for WorkSpaces The following table describes the important changes to the WorkSpaces service and to the Amazon WorkSpaces Administration Guide from January 1, 2018, onward. We also update the documentation frequently to address the feedback that you send us. For notiﬁcation about these updates, you can subscribe to the WorkSpaces RSS feed. Change Description Date Running modes Microsoft Entra ID directory The running mode of a WorkSpaces Pool determine s its immediate availability and your payment method. You can choose between the two running modes when you create a WorkSpaces Pool. Cross-region integration between IAM Identity Center and WorkSpaces is supported. May 15, 2025 February 27, 2025 Microsoft Entra ID directory You can create a dedicated Microsoft Entra ID directory. August 26, 2024 Microsoft Visual Studio Amazon DCV WebRTC Redirection Extension WorkSpaces Pools is now available in AWS GovCloud (US) Region Microsoft Visual Studio bundles are supported for Manage applications. You can install the Amazon DCV WebRTC Redirection Extension to use WebRTC redirection. WorkSpaces Pools oﬀers non- persistent virtual desktops tailored for users who need on-demand access to highly- August 1, 2024 August 1, 2024 July 23, 2024 778 Amazon WorkSpaces Administration Guide curated desktop environme nts hosted on ephemeral infrastructure. WorkSpaces Pools is now available WorkSpaces Pools oﬀers non- persistent virtual desktops June 27, 2024 tailored for users who need on-demand access to highly- curated desktop environme nts hosted on ephemeral infrastructure. AmazonWorkSpacesAdmin managed policy update and new AmazonWorkSpacesPo WorkSpaces updated the AmazonWorkSpacesAd min managed policy and olServiceAccess managed added the new AmazonWor policy kSpacesPoolServiceAccess managed policy. June 27, 2024 AmazonWorkSpacesAdmin managed policy update WorkSpaces added the workspaces:Restore July 17, 2023 SDK extension supported by DCV Workspace action to the AmazonWorkSpacesAdmin managed policy, granting admins access to restore WorkSpaces. With the Amazon DCV Extension SDK, developer s can customize DCV WorkSpaces experience for end users. May 25, 2023 DCV host agent versions Version information for DCV. May 8, 2023 Amazon WorkSpaces launched in AWS GovCloud (US-East) Amazon WorkSpaces is available in the AWS GovCloud (US-East). May 3, 2023 779 Amazon WorkSpaces Administration Guide Amazon WorkSpaces webcam support Amazon WorkSpaces now supports real-time audio-vid April 5, 2021 eo (AV) by seamlessly redirecti ng local webcam video input to Windows WorkSpaces desktops using DCV. Amazon WorkSpaces smart card support with the You can now use the Amazon WorkSpaces macOS client April 5, 2021 WorkSpaces macOS client application with Common application Access Card (CAC) and Personal Identity Veriﬁcat ion (PIV) smart cards. Smart card support is available on WorkSpaces using DCV. Amazon WorkSpaces bundle management APIs Amazon WorkSpaces bundle management APIs are now March 15, 2021 available. These API actions support creation, deletion, and image association operations for WorkSpaces bundles. Amazon WorkSpaces launched in Asia Paciﬁc Amazon WorkSpaces is available in the Asia Paciﬁc March 8, 2021 (Mumbai) Smart Cards December 1, 2020 (Mumbai) Region. Amazon WorkSpaces now supports pre-session (login) and in-session smart card authentication on Windows and Linux WorkSpaces in the AWS GovCloud (US-West) Region. 780 Amazon WorkSpaces DCV Share Custom Images Cross-Region Redirection Subscribe to Microsoft Oﬃce 2016 or
workspaces-ag-258	workspaces-ag.pdf	258	Smart card support is available on WorkSpaces using DCV. Amazon WorkSpaces bundle management APIs Amazon WorkSpaces bundle management APIs are now March 15, 2021 available. These API actions support creation, deletion, and image association operations for WorkSpaces bundles. Amazon WorkSpaces launched in Asia Paciﬁc Amazon WorkSpaces is available in the Asia Paciﬁc March 8, 2021 (Mumbai) Smart Cards December 1, 2020 (Mumbai) Region. Amazon WorkSpaces now supports pre-session (login) and in-session smart card authentication on Windows and Linux WorkSpaces in the AWS GovCloud (US-West) Region. 780 Amazon WorkSpaces DCV Share Custom Images Cross-Region Redirection Subscribe to Microsoft Oﬃce 2016 or 2019 for BYOL WorkSpaces DCV is now available for both license-included (Windows Server 2016) and BYOL Windows 10-based WorkSpaces on all bundle types except for Graphics and GraphicsPro. DCV is also available for Linux WorkSpace s in the AWS GovCloud (US- West) Region. You can now share custom WorkSpaces images across AWS accounts. After an image has been shared, the recipient account can copy the image and use it to create bundles for launching new WorkSpace s. You can now use cross-Reg ion redirection, a feature that works with your Domain Name System (DNS) routing policies to redirect your users to alternative WorkSpace s when their primary WorkSpaces aren't available. You can now subscribe to Microsoft Oﬃce Professio nal 2016 or 2019 provided by AWS on Bring Your Own Windows License (BYOL) WorkSpaces. Administration Guide December 1, 2020 October 1, 2020 September 10, 2020 September 3, 2020 781 Amazon WorkSpaces Administration Guide BYOL Automation in China (Ningxia) You can use Bring Your Own License (BYOL) automation to April 2, 2020 Image Checker Migrate WorkSpaces March 30, 2020 January 9, 2020 simplify the process of using your Windows 10 desktop licenses for your WorkSpaces in China (Ningxia). The Image Checker tool helps you determine whether your Windows WorkSpace meets the requirements for image creation. The Image Checker performs a series of tests on the WorkSpace that you want to use to create your image, and provides guidance on how to resolve any issues it ﬁnds. The Amazon WorkSpace s migrate feature enables you to migrate a WorkSpace from one bundle to another, while retaining the data on the user volume. You can use this feature to migrate WorkSpaces from the Windows 7 desktop experienc e to the Windows 10 desktop experience. You can also use this feature to migrate WorkSpaces from one public or custom bundle to another. 782 Amazon WorkSpaces Administration Guide PrivateLink integration for Amazon WorkSpaces APIs You can connect directly to Amazon WorkSpaces November 25, 2019 API endpoints through an interface endpoint in your Virtual Private Cloud (VPC) instead of connecting over the internet. When you use a VPC interface endpoint, communication between your VPC and the Amazon WorkSpaces API endpoint is conducted entirely and securely within the AWS network. Linux client for Amazon WorkSpaces Users can now use the Linux client to access their November 25, 2019 WorkSpaces. Amazon WorkSpaces launched in China (Ningxia) Amazon WorkSpaces is available in the China November 13, 2019 (Ningxia) Region. Restore WorkSpaces to last known healthy state You can use the restore feature to roll back a September 18, 2019 WorkSpace to its last known healthy state. 783 Amazon WorkSpaces Administration Guide FIPS endpoint encryption Copy WorkSpace images To comply with the Federal Risk and Authorization Management Program (FedRAMP) or the Departmen t of Defense (DoD) Cloud Computing Security Requirements Guide (SRG), you can conﬁgure Amazon WorkSpaces to use Federal Information Processing Standards (FIPS) endpoint encryption at the directory level. You can copy your images within the same Region or across Regions. September 12, 2019 June 27, 2019 Self-Service WorkSpace Management Capabilities for You can enable self-service WorkSpace management November 19, 2018 Users BYOL Automation PowerPro and GraphicsPro bundles capabilities for your users to provide them with more control over their experience. You can use Bring Your Own License (BYOL) automation to simplify the process of using your Windows 7 and Windows 10 desktop licenses for your WorkSpaces. The PowerPro and GraphicsP ro bundles are now available for WorkSpaces. November 16, 2018 October 18, 2018 784 Amazon WorkSpaces Administration Guide Monitor successful WorkSpace logins You can use events from Amazon CloudWatch Events September 17, 2018 to monitor and respond to successful WorkSpace logins. Web Access for Windows 10 WorkSpaces Users can now use the web access client to access August 24, 2018 URI login Amazon Linux WorkSpaces IP access control groups a WorkSpace running the Windows 10 desktop experience. You can use uniform resource identiﬁers (URIs) to provide users with access to their WorkSpaces. You can provision Amazon Linux WorkSpaces for your users. You can control the IP addresses from which users can access their WorkSpaces. July 31, 2018 June 26, 2018 April 30, 2018 In-place upgrades You can upgrade your
workspaces-ag-259	workspaces-ag.pdf	259	Events September 17, 2018 to monitor and respond to successful WorkSpace logins. Web Access for Windows 10 WorkSpaces Users can now use the web access client to access August 24, 2018 URI login Amazon Linux WorkSpaces IP access control groups a WorkSpace running the Windows 10 desktop experience. You can use uniform resource identiﬁers (URIs) to provide users with access to their WorkSpaces. You can provision Amazon Linux WorkSpaces for your users. You can control the IP addresses from which users can access their WorkSpaces. July 31, 2018 June 26, 2018 April 30, 2018 In-place upgrades You can upgrade your Windows 10 BYOL WorkSpace March 9, 2018 s to a newer version of Windows 10. Earlier Updates The following table describes important additions to the Amazon WorkSpaces service and its documentation set before January 1, 2018. Earlier Updates 785 Amazon WorkSpaces Administration Guide Change Description Date Flexible compute options You can switch your WorkSpaces between the Value, Standard, Performance, and Power December 22, 2017 bundles Conﬁgurable storage You can conﬁgure the size of the root and user volumes for your WorkSpaces when you December 22, 2017 launch them and increase the size of these volumes later on. Control device access You can specify the types of devices that have access to WorkSpaces. In addition, you June 19, 2017 can restrict access to WorkSpaces to trusted devices (also known as managed devices). Inter-forest trusts You can establish a trust relationship between your AWS Managed Microsoft AD and your on- February 9, 2017 premises Microsoft Active Directory domain and then provision WorkSpaces for users in the on-premises domain. Windows Server 2016 bundles WorkSpaces oﬀers bundles that include a Windows 10 desktop experience, powered by November 29, 2016 Windows Server 2016. Web Access You can access your Windows WorkSpaces from a web browser using WorkSpaces Web Access. November 18, 2016 Hourly WorkSpaces You can conﬁgure your WorkSpaces so that users are billed by the hour. August 18, 2016 Windows 10 BYOL Tagging support You can bring your Windows 10 Desktop License to WorkSpaces (BYOL). July 21, 2016 You can use tags to manage and track your WorkSpaces. May 17, 2016 Earlier Updates 786 Amazon WorkSpaces Change Description Administration Guide Date Saved registrations Every time you enter a new registration code, the WorkSpaces client stores it. This makes January 28, 2016 it easier to switch between WorkSpaces in diﬀerent directories or Regions. Windows 7 BYOL, Chromeboo k client, WorkSpace encryptio You can bring your Windows 7 Desktop License to WorkSpaces (BYOL), use the October 1, 2015 n Chromebook client, and use WorkSpace encryption. CloudWatch monitoring Added information about CloudWatch monitoring. April 28, 2015 Automatic session reconnect Added information about the auto session reconnect feature in the WorkSpaces desktop March 31, 2015 client applications. Public IP addresses You can automatically assign a public IP address to your WorkSpaces. January 23, 2015 WorkSpaces launched in Asia Paciﬁc (Singapore) WorkSpaces is available in the Asia Paciﬁc (Singapore) Region. January 15, 2015 Value bundle added, Standard bundle updates, Oﬃce 2013 The Value bundle is available, the Standard bundle hardware has been upgraded, and November 6, 2014 added Microsoft Oﬃce 2013 is available in Plus packages. Image and bundle support You can create an image from a WorkSpace that you’ve customized and a custom WorkSpace bundle from the image. October 28, 2014 PCoIP zero client support You can access WorkSpaces PCoIP zero client devices. October 15, 2014 WorkSpaces launched in Asia Paciﬁc (Tokyo) WorkSpaces is available in the Asia Paciﬁc (Tokyo) Region. August 26, 2014 Earlier Updates 787 Amazon WorkSpaces Change Description Administration Guide Date Local printer support You can enable local printer support for your WorkSpaces. August 26, 2014 Multi-factor authentication You can use multi-factor authentication in connected directories. August 11, 2014 Default OU support and target domain support You can select a default Organizational Unit (OU) where your WorkSpace machine accounts July 7, 2014 are placed, and a separate domain where your WorkSpace machine accounts are created. Add security groups You can add a security group to your WorkSpaces. July 7, 2014 WorkSpaces launched in Asia Paciﬁc (Sydney) WorkSpaces is available in the Asia Paciﬁc (Sydney) Region. May 15, 2014 WorkSpaces launched in Europe (Ireland) WorkSpaces is available in the Europe (Ireland) Region. May 5, 2014 Public beta WorkSpaces is available as a public beta. March 25, 2014 Earlier Updates 788
workspaces-api-001	workspaces-api.pdf	1	API Reference Amazon WorkSpaces Service API Version 2015-04-08 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon WorkSpaces Service API Reference Amazon WorkSpaces Service: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. 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 aﬃliated with, connected to, or sponsored by Amazon. Amazon WorkSpaces Service Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 AcceptAccountLinkInvitation ...................................................................................................................... 6 Request Syntax ........................................................................................................................................ 6 Request Parameters ................................................................................................................................ 6 Response Syntax ...................................................................................................................................... 7 Response Elements ................................................................................................................................. 7 Errors .......................................................................................................................................................... 7 See Also ..................................................................................................................................................... 8 AssociateConnectionAlias ............................................................................................................................ 9 Request Syntax ........................................................................................................................................ 9 Request Parameters ................................................................................................................................ 9 Response Syntax ................................................................................................................................... 10 Response Elements ............................................................................................................................... 10 Errors ....................................................................................................................................................... 10 See Also .................................................................................................................................................. 11 AssociateIpGroups ...................................................................................................................................... 12 Request Syntax ...................................................................................................................................... 12 Request Parameters .............................................................................................................................. 12 Response Elements ............................................................................................................................... 12 Errors ....................................................................................................................................................... 13 See Also .................................................................................................................................................. 13 AssociateWorkspaceApplication .............................................................................................................. 15 Request Syntax ...................................................................................................................................... 15 Request Parameters .............................................................................................................................. 15 Response Syntax ................................................................................................................................... 15 Response Elements ............................................................................................................................... 16 Errors ....................................................................................................................................................... 16 See Also .................................................................................................................................................. 17 AuthorizeIpRules ......................................................................................................................................... 19 Request Syntax ...................................................................................................................................... 19 Request Parameters .............................................................................................................................. 19 Response Elements ............................................................................................................................... 20 Errors ....................................................................................................................................................... 20 API Version 2015-04-08 iii Amazon WorkSpaces Service API Reference See Also .................................................................................................................................................. 20 CopyWorkspaceImage ................................................................................................................................ 22 Request Syntax ...................................................................................................................................... 22 Request Parameters .............................................................................................................................. 22 Response Syntax ................................................................................................................................... 24 Response Elements ............................................................................................................................... 24 Errors ....................................................................................................................................................... 24 See Also .................................................................................................................................................. 25 CreateAccountLinkInvitation .................................................................................................................... 27 Request Syntax ...................................................................................................................................... 27 Request Parameters .............................................................................................................................. 27 Response Syntax ................................................................................................................................... 27 Response Elements ............................................................................................................................... 28 Errors ....................................................................................................................................................... 28 See Also .................................................................................................................................................. 29 CreateConnectClientAddIn ....................................................................................................................... 30 Request Syntax ...................................................................................................................................... 30 Request Parameters .............................................................................................................................. 30 Response Syntax ................................................................................................................................... 31 Response Elements ............................................................................................................................... 31 Errors ....................................................................................................................................................... 31 See Also .................................................................................................................................................. 32 CreateConnectionAlias .............................................................................................................................. 34 Request Syntax ...................................................................................................................................... 34 Request Parameters .............................................................................................................................. 34 Response Syntax ................................................................................................................................... 35 Response Elements ............................................................................................................................... 35 Errors ....................................................................................................................................................... 35 See Also .................................................................................................................................................. 36 CreateIpGroup ............................................................................................................................................. 38 Request Syntax ...................................................................................................................................... 38 Request Parameters .............................................................................................................................. 38 Response Syntax ................................................................................................................................... 39 Response Elements ............................................................................................................................... 39 Errors ....................................................................................................................................................... 40 See Also .................................................................................................................................................. 40 API Version 2015-04-08 iv Amazon WorkSpaces Service API Reference CreateStandbyWorkspaces ....................................................................................................................... 42 Request Syntax ...................................................................................................................................... 42 Request Parameters .............................................................................................................................. 42 Response Syntax ................................................................................................................................... 43 Response Elements ............................................................................................................................... 43 Errors ....................................................................................................................................................... 44 See Also .................................................................................................................................................. 45 CreateTags ................................................................................................................................................... 46 Request Syntax ...................................................................................................................................... 46 Request Parameters .............................................................................................................................. 46 Response Elements ............................................................................................................................... 46 Errors ....................................................................................................................................................... 47 See Also .................................................................................................................................................. 47 CreateUpdatedWorkspaceImage ............................................................................................................. 48 Request Syntax ...................................................................................................................................... 48 Request Parameters .............................................................................................................................. 48 Response Syntax ................................................................................................................................... 50 Response Elements ............................................................................................................................... 50 Errors ....................................................................................................................................................... 50 See Also .................................................................................................................................................. 51 CreateWorkspaceBundle ........................................................................................................................... 53 Request Syntax ...................................................................................................................................... 53 Request Parameters .............................................................................................................................. 53 Response Syntax ................................................................................................................................... 55 Response Elements ............................................................................................................................... 55 Errors ....................................................................................................................................................... 56 See Also .................................................................................................................................................. 57 CreateWorkspaceImage ............................................................................................................................. 58 Request Syntax ...................................................................................................................................... 58 Request Parameters .............................................................................................................................. 58 Response Syntax ................................................................................................................................... 59 Response Elements ............................................................................................................................... 59 Errors ....................................................................................................................................................... 61 See Also .................................................................................................................................................. 62 CreateWorkspaces ...................................................................................................................................... 63 Request Syntax ...................................................................................................................................... 63 API Version 2015-04-08 v Amazon WorkSpaces Service API Reference Request Parameters .............................................................................................................................. 64 Response Syntax ................................................................................................................................... 64 Response Elements ............................................................................................................................... 66 Errors ....................................................................................................................................................... 67 See Also .................................................................................................................................................. 67 CreateWorkspacesPool .............................................................................................................................. 69 Request Syntax ...................................................................................................................................... 69 Request Parameters .............................................................................................................................. 69 Response Syntax ................................................................................................................................... 71 Response Elements ............................................................................................................................... 72 Errors ....................................................................................................................................................... 72 See Also .................................................................................................................................................. 73 DeleteAccountLinkInvitation .................................................................................................................... 75 Request Syntax ...................................................................................................................................... 75 Request Parameters .............................................................................................................................. 75 Response Syntax ................................................................................................................................... 75 Response Elements ............................................................................................................................... 76 Errors ....................................................................................................................................................... 76 See Also .................................................................................................................................................. 77 DeleteClientBranding ................................................................................................................................. 78 Request Syntax ...................................................................................................................................... 78 Request Parameters .............................................................................................................................. 78 Response Elements ............................................................................................................................... 79 Errors ....................................................................................................................................................... 79 See Also .................................................................................................................................................. 79 DeleteConnectClientAddIn ....................................................................................................................... 81 Request Syntax ...................................................................................................................................... 81 Request Parameters .............................................................................................................................. 81 Response Elements ............................................................................................................................... 81 Errors ....................................................................................................................................................... 82 See Also .................................................................................................................................................. 82 DeleteConnectionAlias .............................................................................................................................. 83 Request Syntax ...................................................................................................................................... 83 Request Parameters .............................................................................................................................. 83 Response Elements ............................................................................................................................... 84 Errors ....................................................................................................................................................... 84 API Version 2015-04-08 vi Amazon WorkSpaces Service API Reference See Also .................................................................................................................................................. 85 DeleteIpGroup ............................................................................................................................................. 86 Request Syntax ...................................................................................................................................... 86 Request Parameters .............................................................................................................................. 86 Response Elements ............................................................................................................................... 86 Errors ....................................................................................................................................................... 86 See Also .................................................................................................................................................. 87 DeleteTags ................................................................................................................................................... 88 Request Syntax ...................................................................................................................................... 88 Request Parameters .............................................................................................................................. 88 Response Elements ............................................................................................................................... 88 Errors ....................................................................................................................................................... 88 See Also .................................................................................................................................................. 89 DeleteWorkspaceBundle ........................................................................................................................... 90 Request Syntax ...................................................................................................................................... 90 Request Parameters .............................................................................................................................. 90 Response Elements ............................................................................................................................... 90 Errors ....................................................................................................................................................... 90 See Also .................................................................................................................................................. 91 DeleteWorkspaceImage ............................................................................................................................. 92 Request Syntax ...................................................................................................................................... 92 Request Parameters .............................................................................................................................. 92 Response Elements ............................................................................................................................... 92 Errors ....................................................................................................................................................... 92 See Also .................................................................................................................................................. 93 DeployWorkspaceApplications ................................................................................................................. 94 Request Syntax ...................................................................................................................................... 94 Request Parameters .............................................................................................................................. 94 Response Syntax ................................................................................................................................... 94 Response Elements ............................................................................................................................... 95 Errors ....................................................................................................................................................... 95 See Also .................................................................................................................................................. 96 DeregisterWorkspaceDirectory ................................................................................................................
workspaces-api-002	workspaces-api.pdf	2	....................................................................................................................................................... 86 See Also .................................................................................................................................................. 87 DeleteTags ................................................................................................................................................... 88 Request Syntax ...................................................................................................................................... 88 Request Parameters .............................................................................................................................. 88 Response Elements ............................................................................................................................... 88 Errors ....................................................................................................................................................... 88 See Also .................................................................................................................................................. 89 DeleteWorkspaceBundle ........................................................................................................................... 90 Request Syntax ...................................................................................................................................... 90 Request Parameters .............................................................................................................................. 90 Response Elements ............................................................................................................................... 90 Errors ....................................................................................................................................................... 90 See Also .................................................................................................................................................. 91 DeleteWorkspaceImage ............................................................................................................................. 92 Request Syntax ...................................................................................................................................... 92 Request Parameters .............................................................................................................................. 92 Response Elements ............................................................................................................................... 92 Errors ....................................................................................................................................................... 92 See Also .................................................................................................................................................. 93 DeployWorkspaceApplications ................................................................................................................. 94 Request Syntax ...................................................................................................................................... 94 Request Parameters .............................................................................................................................. 94 Response Syntax ................................................................................................................................... 94 Response Elements ............................................................................................................................... 95 Errors ....................................................................................................................................................... 95 See Also .................................................................................................................................................. 96 DeregisterWorkspaceDirectory ................................................................................................................ 97 Request Syntax ...................................................................................................................................... 97 Request Parameters .............................................................................................................................. 97 Response Elements ............................................................................................................................... 98 API Version 2015-04-08 vii Amazon WorkSpaces Service API Reference Errors ....................................................................................................................................................... 98 See Also .................................................................................................................................................. 98 DescribeAccount ....................................................................................................................................... 100 Response Syntax ................................................................................................................................. 100 Response Elements ............................................................................................................................ 100 Errors ..................................................................................................................................................... 101 See Also ................................................................................................................................................ 101 DescribeAccountModiﬁcations ............................................................................................................... 102 Request Syntax .................................................................................................................................... 102 Request Parameters ........................................................................................................................... 102 Response Syntax ................................................................................................................................. 102 Response Elements ............................................................................................................................ 103 Errors ..................................................................................................................................................... 103 See Also ................................................................................................................................................ 103 DescribeApplicationAssociations ........................................................................................................... 105 Request Syntax .................................................................................................................................... 105 Request Parameters ........................................................................................................................... 105 Response Syntax ................................................................................................................................. 106 Response Elements ............................................................................................................................ 106 Errors ..................................................................................................................................................... 107 See Also ................................................................................................................................................ 107 DescribeApplications ............................................................................................................................... 109 Request Syntax .................................................................................................................................... 109 Request Parameters ........................................................................................................................... 109 Response Syntax ................................................................................................................................. 111 Response Elements ............................................................................................................................ 111 Errors ..................................................................................................................................................... 112 See Also ................................................................................................................................................ 112 DescribeBundleAssociations ................................................................................................................... 114 Request Syntax .................................................................................................................................... 114 Request Parameters ........................................................................................................................... 114 Response Syntax ................................................................................................................................. 114 Response Elements ............................................................................................................................ 115 Errors ..................................................................................................................................................... 115 See Also ................................................................................................................................................ 116 DescribeClientBranding ........................................................................................................................... 117 API Version 2015-04-08 viii Amazon WorkSpaces Service API Reference Request Syntax .................................................................................................................................... 117 Request Parameters ........................................................................................................................... 117 Response Syntax ................................................................................................................................. 117 Response Elements ............................................................................................................................ 119 Errors ..................................................................................................................................................... 120 See Also ................................................................................................................................................ 120 DescribeClientProperties ........................................................................................................................ 122 Request Syntax .................................................................................................................................... 122 Request Parameters ........................................................................................................................... 122 Response Syntax ................................................................................................................................. 122 Response Elements ............................................................................................................................ 123 Errors ..................................................................................................................................................... 123 See Also ................................................................................................................................................ 123 DescribeConnectClientAddIns ................................................................................................................ 125 Request Syntax .................................................................................................................................... 125 Request Parameters ........................................................................................................................... 125 Response Syntax ................................................................................................................................. 126 Response Elements ............................................................................................................................ 126 Errors ..................................................................................................................................................... 126 See Also ................................................................................................................................................ 127 DescribeConnectionAliases ..................................................................................................................... 128 Request Syntax .................................................................................................................................... 128 Request Parameters ........................................................................................................................... 128 Response Syntax ................................................................................................................................. 129 Response Elements ............................................................................................................................ 130 Errors ..................................................................................................................................................... 130 See Also ................................................................................................................................................ 131 DescribeConnectionAliasPermissions ................................................................................................... 132 Request Syntax .................................................................................................................................... 132 Request Parameters ........................................................................................................................... 132 Response Syntax ................................................................................................................................. 133 Response Elements ............................................................................................................................ 133 Errors ..................................................................................................................................................... 134 See Also ................................................................................................................................................ 134 DescribeImageAssociations .................................................................................................................... 136 Request Syntax .................................................................................................................................... 136 API Version 2015-04-08 ix Amazon WorkSpaces Service API Reference Request Parameters ........................................................................................................................... 136 Response Syntax ................................................................................................................................. 136 Response Elements ............................................................................................................................ 137 Errors ..................................................................................................................................................... 137 See Also ................................................................................................................................................ 138 DescribeIpGroups ..................................................................................................................................... 139 Request Syntax .................................................................................................................................... 139 Request Parameters ........................................................................................................................... 139 Response Syntax ................................................................................................................................. 140 Response Elements ............................................................................................................................ 140 Errors ..................................................................................................................................................... 141 See Also ................................................................................................................................................ 141 DescribeTags ............................................................................................................................................. 142 Request Syntax .................................................................................................................................... 142 Request Parameters ........................................................................................................................... 142 Response Syntax ................................................................................................................................. 142 Response Elements ............................................................................................................................ 142 Errors ..................................................................................................................................................... 143 See Also ................................................................................................................................................ 143 DescribeWorkspaceAssociations ............................................................................................................ 144 Request Syntax .................................................................................................................................... 144 Request Parameters ........................................................................................................................... 144 Response Syntax ................................................................................................................................. 144 Response Elements ............................................................................................................................ 145 Errors ..................................................................................................................................................... 145 See Also ................................................................................................................................................ 146 DescribeWorkspaceBundles .................................................................................................................... 147 Request Syntax .................................................................................................................................... 147 Request Parameters ........................................................................................................................... 147 Response Syntax ................................................................................................................................. 148 Response Elements ............................................................................................................................ 148 Errors ..................................................................................................................................................... 149 See Also ................................................................................................................................................ 149 DescribeWorkspaceDirectories ............................................................................................................... 151 Request Syntax .................................................................................................................................... 151 Request Parameters ........................................................................................................................... 151 API Version 2015-04-08 x Amazon WorkSpaces Service API Reference Response Syntax ................................................................................................................................. 152 Response Elements ............................................................................................................................ 155 Errors ..................................................................................................................................................... 155 See Also ................................................................................................................................................ 155 DescribeWorkspaceImagePermissions ................................................................................................. 157 Request Syntax .................................................................................................................................... 157 Request Parameters ........................................................................................................................... 157 Response Syntax ................................................................................................................................. 158 Response Elements ............................................................................................................................ 158 Errors ..................................................................................................................................................... 159 See Also ................................................................................................................................................ 159 DescribeWorkspaceImages ..................................................................................................................... 161 Request Syntax .................................................................................................................................... 161 Request Parameters ........................................................................................................................... 161 Response Syntax ................................................................................................................................. 162 Response Elements ............................................................................................................................ 163 Errors ..................................................................................................................................................... 163 See Also ................................................................................................................................................ 163 DescribeWorkspaces ................................................................................................................................ 165 Request Syntax .................................................................................................................................... 165 Request Parameters ........................................................................................................................... 165 Response Syntax ................................................................................................................................. 167 Response Elements ............................................................................................................................ 168 Errors ..................................................................................................................................................... 169 See Also ................................................................................................................................................ 169 DescribeWorkspacesConnectionStatus ................................................................................................ 171 Request Syntax .................................................................................................................................... 171 Request Parameters ........................................................................................................................... 171 Response Syntax ................................................................................................................................. 171 Response Elements ............................................................................................................................ 172 Errors ..................................................................................................................................................... 172 See Also ................................................................................................................................................ 173 DescribeWorkspaceSnapshots ............................................................................................................... 174 Request Syntax .................................................................................................................................... 174 Request Parameters ........................................................................................................................... 174 Response Syntax ................................................................................................................................. 174 API Version 2015-04-08 xi Amazon WorkSpaces Service API Reference Response Elements ............................................................................................................................ 175 Errors ..................................................................................................................................................... 175 See Also ................................................................................................................................................ 176 DescribeWorkspacesPools ...................................................................................................................... 177 Request Syntax .................................................................................................................................... 177 Request Parameters ........................................................................................................................... 177 Response Syntax ................................................................................................................................. 178 Response Elements ............................................................................................................................ 179 Errors ..................................................................................................................................................... 180 See Also ................................................................................................................................................ 180 DescribeWorkspacesPoolSessions ......................................................................................................... 181 Request Syntax .................................................................................................................................... 181 Request Parameters ........................................................................................................................... 181 Response Syntax ................................................................................................................................. 182 Response Elements ............................................................................................................................ 182 Errors ..................................................................................................................................................... 183 See Also ................................................................................................................................................ 183 DisassociateConnectionAlias .................................................................................................................. 185 Request Syntax .................................................................................................................................... 185 Request Parameters ........................................................................................................................... 185 Response Elements ............................................................................................................................ 185 Errors ..................................................................................................................................................... 186 See Also ................................................................................................................................................ 186 DisassociateIpGroups ............................................................................................................................... 188 Request Syntax .................................................................................................................................... 188 Request Parameters ........................................................................................................................... 188 Response Elements ............................................................................................................................ 188 Errors ..................................................................................................................................................... 189 See Also ................................................................................................................................................ 189 DisassociateWorkspaceApplication
workspaces-api-003	workspaces-api.pdf	3	Also ................................................................................................................................................ 176 DescribeWorkspacesPools ...................................................................................................................... 177 Request Syntax .................................................................................................................................... 177 Request Parameters ........................................................................................................................... 177 Response Syntax ................................................................................................................................. 178 Response Elements ............................................................................................................................ 179 Errors ..................................................................................................................................................... 180 See Also ................................................................................................................................................ 180 DescribeWorkspacesPoolSessions ......................................................................................................... 181 Request Syntax .................................................................................................................................... 181 Request Parameters ........................................................................................................................... 181 Response Syntax ................................................................................................................................. 182 Response Elements ............................................................................................................................ 182 Errors ..................................................................................................................................................... 183 See Also ................................................................................................................................................ 183 DisassociateConnectionAlias .................................................................................................................. 185 Request Syntax .................................................................................................................................... 185 Request Parameters ........................................................................................................................... 185 Response Elements ............................................................................................................................ 185 Errors ..................................................................................................................................................... 186 See Also ................................................................................................................................................ 186 DisassociateIpGroups ............................................................................................................................... 188 Request Syntax .................................................................................................................................... 188 Request Parameters ........................................................................................................................... 188 Response Elements ............................................................................................................................ 188 Errors ..................................................................................................................................................... 189 See Also ................................................................................................................................................ 189 DisassociateWorkspaceApplication ....................................................................................................... 191 Request Syntax .................................................................................................................................... 191 Request Parameters ........................................................................................................................... 191 Response Syntax ................................................................................................................................. 191 Response Elements ............................................................................................................................ 192 Errors ..................................................................................................................................................... 192 See Also ................................................................................................................................................ 193 API Version 2015-04-08 xii Amazon WorkSpaces Service API Reference GetAccountLink ......................................................................................................................................... 194 Request Syntax .................................................................................................................................... 194 Request Parameters ........................................................................................................................... 194 Response Syntax ................................................................................................................................. 194 Response Elements ............................................................................................................................ 195 Errors ..................................................................................................................................................... 195 See Also ................................................................................................................................................ 196 ImportClientBranding .............................................................................................................................. 197 Request Syntax .................................................................................................................................... 197 Request Parameters ........................................................................................................................... 199 Response Syntax ................................................................................................................................. 200 Response Elements ............................................................................................................................ 201 Errors ..................................................................................................................................................... 202 See Also ................................................................................................................................................ 203 ImportWorkspaceImage .......................................................................................................................... 204 Request Syntax .................................................................................................................................... 204 Request Parameters ........................................................................................................................... 204 Response Syntax ................................................................................................................................. 206 Response Elements ............................................................................................................................ 206 Errors ..................................................................................................................................................... 207 See Also ................................................................................................................................................ 208 ListAccountLinks ....................................................................................................................................... 209 Request Syntax .................................................................................................................................... 209 Request Parameters ........................................................................................................................... 209 Response Syntax ................................................................................................................................. 210 Response Elements ............................................................................................................................ 210 Errors ..................................................................................................................................................... 210 See Also ................................................................................................................................................ 211 ListAvailableManagementCidrRanges .................................................................................................. 212 Request Syntax .................................................................................................................................... 212 Request Parameters ........................................................................................................................... 212 Response Syntax ................................................................................................................................. 213 Response Elements ............................................................................................................................ 213 Errors ..................................................................................................................................................... 214 See Also ................................................................................................................................................ 214 MigrateWorkspace .................................................................................................................................... 215 API Version 2015-04-08 xiii Amazon WorkSpaces Service API Reference Request Syntax .................................................................................................................................... 215 Request Parameters ........................................................................................................................... 215 Response Syntax ................................................................................................................................. 216 Response Elements ............................................................................................................................ 216 Errors ..................................................................................................................................................... 216 See Also ................................................................................................................................................ 217 ModifyAccount .......................................................................................................................................... 219 Request Syntax .................................................................................................................................... 219 Request Parameters ........................................................................................................................... 219 Response Elements ............................................................................................................................ 220 Errors ..................................................................................................................................................... 220 See Also ................................................................................................................................................ 220 ModifyCertiﬁcateBasedAuthProperties ............................................................................................... 222 Request Syntax .................................................................................................................................... 222 Request Parameters ........................................................................................................................... 222 Response Elements ............................................................................................................................ 223 Errors ..................................................................................................................................................... 223 See Also ................................................................................................................................................ 223 ModifyClientProperties ........................................................................................................................... 225 Request Syntax .................................................................................................................................... 225 Request Parameters ........................................................................................................................... 225 Response Elements ............................................................................................................................ 225 Errors ..................................................................................................................................................... 225 See Also ................................................................................................................................................ 226 ModifyEndpointEncryptionMode .......................................................................................................... 227 Request Syntax .................................................................................................................................... 227 Request Parameters ........................................................................................................................... 227 Response Elements ............................................................................................................................ 227 Errors ..................................................................................................................................................... 228 See Also ................................................................................................................................................ 228 ModifySamlProperties ............................................................................................................................. 229 Request Syntax .................................................................................................................................... 229 Request Parameters ........................................................................................................................... 229 Response Elements ............................................................................................................................ 230 Errors ..................................................................................................................................................... 230 See Also ................................................................................................................................................ 231 API Version 2015-04-08 xiv Amazon WorkSpaces Service API Reference ModifySelfservicePermissions ................................................................................................................ 232 Request Syntax .................................................................................................................................... 232 Request Parameters ........................................................................................................................... 232 Response Elements ............................................................................................................................ 233 Errors ..................................................................................................................................................... 233 See Also ................................................................................................................................................ 233 ModifyStreamingProperties ................................................................................................................... 235 Request Syntax .................................................................................................................................... 235 Request Parameters ........................................................................................................................... 235 Response Elements ............................................................................................................................ 236 Errors ..................................................................................................................................................... 236 See Also ................................................................................................................................................ 237 ModifyWorkspaceAccessProperties ...................................................................................................... 238 Request Syntax .................................................................................................................................... 238 Request Parameters ........................................................................................................................... 238 Response Elements ............................................................................................................................ 239 Errors ..................................................................................................................................................... 239 See Also ................................................................................................................................................ 239 ModifyWorkspaceCreationProperties ................................................................................................... 241 Request Syntax .................................................................................................................................... 241 Request Parameters ........................................................................................................................... 241 Response Elements ............................................................................................................................ 242 Errors ..................................................................................................................................................... 242 See Also ................................................................................................................................................ 242 ModifyWorkspaceProperties .................................................................................................................. 244 Request Syntax .................................................................................................................................... 244 Request Parameters ........................................................................................................................... 244 Response Elements ............................................................................................................................ 245 Errors ..................................................................................................................................................... 245 See Also ................................................................................................................................................ 246 ModifyWorkspaceState ........................................................................................................................... 248 Request Syntax .................................................................................................................................... 248 Request Parameters ........................................................................................................................... 248 Response Elements ............................................................................................................................ 248 Errors ..................................................................................................................................................... 249 See Also ................................................................................................................................................ 249 API Version 2015-04-08 xv Amazon WorkSpaces Service API Reference RebootWorkspaces ................................................................................................................................... 251 Request Syntax .................................................................................................................................... 251 Request Parameters ........................................................................................................................... 251 Response Syntax ................................................................................................................................. 251 Response Elements ............................................................................................................................ 252 Errors ..................................................................................................................................................... 252 See Also ................................................................................................................................................ 252 RebuildWorkspaces .................................................................................................................................. 254 Request Syntax .................................................................................................................................... 254 Request Parameters ........................................................................................................................... 254 Response Syntax ................................................................................................................................. 254 Response Elements ............................................................................................................................ 255 Errors ..................................................................................................................................................... 255 See Also ................................................................................................................................................ 255 RegisterWorkspaceDirectory .................................................................................................................. 257 Request Syntax .................................................................................................................................... 257 Request Parameters ........................................................................................................................... 257 Response Syntax ................................................................................................................................. 260 Response Elements ............................................................................................................................ 261 Errors ..................................................................................................................................................... 261 See Also ................................................................................................................................................ 262 RejectAccountLinkInvitation ................................................................................................................... 264 Request Syntax .................................................................................................................................... 264 Request Parameters ........................................................................................................................... 264 Response Syntax ................................................................................................................................. 264 Response Elements ............................................................................................................................ 265 Errors ..................................................................................................................................................... 265 See Also ................................................................................................................................................ 266 RestoreWorkspace .................................................................................................................................... 267 Request Syntax .................................................................................................................................... 267 Request Parameters ........................................................................................................................... 267 Response Elements ............................................................................................................................ 267 Errors ..................................................................................................................................................... 267 See Also ................................................................................................................................................ 268 RevokeIpRules ........................................................................................................................................... 269 Request Syntax .................................................................................................................................... 269 API Version 2015-04-08 xvi Amazon WorkSpaces Service API Reference Request Parameters ........................................................................................................................... 269 Response Elements ............................................................................................................................ 269 Errors ..................................................................................................................................................... 269 See Also ................................................................................................................................................ 270 StartWorkspaces ....................................................................................................................................... 271 Request Syntax .................................................................................................................................... 271 Request Parameters ........................................................................................................................... 271 Response Syntax ................................................................................................................................. 271 Response Elements ............................................................................................................................ 272 Errors ..................................................................................................................................................... 272 See Also ................................................................................................................................................ 272 StartWorkspacesPool ............................................................................................................................... 273 Request Syntax .................................................................................................................................... 273 Request Parameters ........................................................................................................................... 273 Response Elements ............................................................................................................................ 273 Errors ..................................................................................................................................................... 273 See Also ................................................................................................................................................ 274 StopWorkspaces ....................................................................................................................................... 276 Request Syntax .................................................................................................................................... 276 Request Parameters ........................................................................................................................... 276 Response Syntax ................................................................................................................................. 276 Response Elements ............................................................................................................................ 277 Errors ..................................................................................................................................................... 277 See Also ................................................................................................................................................ 277 StopWorkspacesPool ............................................................................................................................... 278 Request Syntax .................................................................................................................................... 278 Request Parameters ...........................................................................................................................
workspaces-api-004	workspaces-api.pdf	4	Reference Request Parameters ........................................................................................................................... 269 Response Elements ............................................................................................................................ 269 Errors ..................................................................................................................................................... 269 See Also ................................................................................................................................................ 270 StartWorkspaces ....................................................................................................................................... 271 Request Syntax .................................................................................................................................... 271 Request Parameters ........................................................................................................................... 271 Response Syntax ................................................................................................................................. 271 Response Elements ............................................................................................................................ 272 Errors ..................................................................................................................................................... 272 See Also ................................................................................................................................................ 272 StartWorkspacesPool ............................................................................................................................... 273 Request Syntax .................................................................................................................................... 273 Request Parameters ........................................................................................................................... 273 Response Elements ............................................................................................................................ 273 Errors ..................................................................................................................................................... 273 See Also ................................................................................................................................................ 274 StopWorkspaces ....................................................................................................................................... 276 Request Syntax .................................................................................................................................... 276 Request Parameters ........................................................................................................................... 276 Response Syntax ................................................................................................................................. 276 Response Elements ............................................................................................................................ 277 Errors ..................................................................................................................................................... 277 See Also ................................................................................................................................................ 277 StopWorkspacesPool ............................................................................................................................... 278 Request Syntax .................................................................................................................................... 278 Request Parameters ........................................................................................................................... 278 Response Elements ............................................................................................................................ 278 Errors ..................................................................................................................................................... 278 See Also ................................................................................................................................................ 279 TerminateWorkspaces ............................................................................................................................. 280 Request Syntax .................................................................................................................................... 280 Request Parameters ........................................................................................................................... 281 Response Syntax ................................................................................................................................. 281 Response Elements ............................................................................................................................ 281 Errors ..................................................................................................................................................... 282 API Version 2015-04-08 xvii Amazon WorkSpaces Service API Reference See Also ................................................................................................................................................ 282 TerminateWorkspacesPool ..................................................................................................................... 283 Request Syntax .................................................................................................................................... 283 Request Parameters ........................................................................................................................... 283 Response Elements ............................................................................................................................ 283 Errors ..................................................................................................................................................... 283 See Also ................................................................................................................................................ 284 TerminateWorkspacesPoolSession ........................................................................................................ 285 Request Syntax .................................................................................................................................... 285 Request Parameters ........................................................................................................................... 285 Response Elements ............................................................................................................................ 285 Errors ..................................................................................................................................................... 285 See Also ................................................................................................................................................ 286 UpdateConnectClientAddIn .................................................................................................................... 287 Request Syntax .................................................................................................................................... 287 Request Parameters ........................................................................................................................... 287 Response Elements ............................................................................................................................ 288 Errors ..................................................................................................................................................... 288 See Also ................................................................................................................................................ 289 UpdateConnectionAliasPermission ....................................................................................................... 290 Request Syntax .................................................................................................................................... 290 Request Parameters ........................................................................................................................... 290 Response Elements ............................................................................................................................ 291 Errors ..................................................................................................................................................... 291 See Also ................................................................................................................................................ 292 UpdateRulesOfIpGroup ........................................................................................................................... 293 Request Syntax .................................................................................................................................... 293 Request Parameters ........................................................................................................................... 293 Response Elements ............................................................................................................................ 293 Errors ..................................................................................................................................................... 294 See Also ................................................................................................................................................ 294 UpdateWorkspaceBundle ....................................................................................................................... 296 Request Syntax .................................................................................................................................... 296 Request Parameters ........................................................................................................................... 296 Response Elements ............................................................................................................................ 297 Errors ..................................................................................................................................................... 297 API Version 2015-04-08 xviii Amazon WorkSpaces Service API Reference See Also ................................................................................................................................................ 297 UpdateWorkspaceImagePermission ..................................................................................................... 299 Request Syntax .................................................................................................................................... 299 Request Parameters ........................................................................................................................... 299 Response Elements ............................................................................................................................ 300 Errors ..................................................................................................................................................... 300 See Also ................................................................................................................................................ 301 UpdateWorkspacesPool .......................................................................................................................... 303 Request Syntax .................................................................................................................................... 303 Request Parameters ........................................................................................................................... 303 Response Syntax ................................................................................................................................. 305 Response Elements ............................................................................................................................ 306 Errors ..................................................................................................................................................... 306 See Also ................................................................................................................................................ 307 Data Types ................................................................................................................................... 308 AccountLink ............................................................................................................................................... 311 Contents ............................................................................................................................................... 311 See Also ................................................................................................................................................ 312 AccountModiﬁcation ................................................................................................................................ 313 Contents ............................................................................................................................................... 313 See Also ................................................................................................................................................ 314 ActiveDirectoryConﬁg ............................................................................................................................. 315 Contents ............................................................................................................................................... 315 See Also ................................................................................................................................................ 315 ApplicationResourceAssociation ............................................................................................................ 316 Contents ............................................................................................................................................... 316 See Also ................................................................................................................................................ 317 ApplicationSettingsRequest ................................................................................................................... 318 Contents ............................................................................................................................................... 318 See Also ................................................................................................................................................ 318 ApplicationSettingsResponse ................................................................................................................ 319 Contents ............................................................................................................................................... 319 See Also ................................................................................................................................................ 320 AssociationStateReason .......................................................................................................................... 321 Contents ............................................................................................................................................... 321 See Also ................................................................................................................................................ 321 API Version 2015-04-08 xix Amazon WorkSpaces Service API Reference BundleResourceAssociation .................................................................................................................... 322 Contents ............................................................................................................................................... 322 See Also ................................................................................................................................................ 323 Capacity ...................................................................................................................................................... 324 Contents ............................................................................................................................................... 324 See Also ................................................................................................................................................ 324 CapacityStatus .......................................................................................................................................... 325 Contents ............................................................................................................................................... 325 See Also ................................................................................................................................................ 326 CertiﬁcateBasedAuthProperties ............................................................................................................ 327 Contents ............................................................................................................................................... 327 See Also ................................................................................................................................................ 327 ClientProperties ........................................................................................................................................ 328 Contents ............................................................................................................................................... 328 See Also ................................................................................................................................................ 328 ClientPropertiesResult ............................................................................................................................. 329 Contents ............................................................................................................................................... 329 See Also ................................................................................................................................................ 329 ComputeType ............................................................................................................................................ 330 Contents ............................................................................................................................................... 330 See Also ................................................................................................................................................ 330 ConnectClientAddIn ................................................................................................................................. 331 Contents ............................................................................................................................................... 331 See Also ................................................................................................................................................ 332 ConnectionAlias ........................................................................................................................................ 333 Contents ............................................................................................................................................... 333 See Also ................................................................................................................................................ 334 ConnectionAliasAssociation ................................................................................................................... 335 Contents ............................................................................................................................................... 335 See Also ................................................................................................................................................ 336 ConnectionAliasPermission .................................................................................................................... 337 Contents ............................................................................................................................................... 337 See Also ................................................................................................................................................ 337 DataReplicationSettings ......................................................................................................................... 338 Contents ............................................................................................................................................... 338 See Also ................................................................................................................................................ 338 API Version 2015-04-08 xx Amazon WorkSpaces Service API Reference DefaultClientBrandingAttributes .......................................................................................................... 339 Contents ............................................................................................................................................... 339 See Also ................................................................................................................................................ 341 DefaultImportClientBrandingAttributes .............................................................................................. 342 Contents ............................................................................................................................................... 342 See Also ................................................................................................................................................ 344 DefaultWorkspaceCreationProperties .................................................................................................. 345 Contents ............................................................................................................................................... 345 See Also ................................................................................................................................................ 346 DescribeWorkspaceDirectoriesFilter ..................................................................................................... 347 Contents ............................................................................................................................................... 347 See Also ................................................................................................................................................ 347 DescribeWorkspacesPoolsFilter ............................................................................................................. 348 Contents ............................................................................................................................................... 348 See Also ................................................................................................................................................ 348 ErrorDetails ................................................................................................................................................ 350 Contents ............................................................................................................................................... 350 See Also ................................................................................................................................................ 351 FailedCreateStandbyWorkspacesRequest ............................................................................................ 352 Contents ............................................................................................................................................... 352 See Also ................................................................................................................................................ 352 FailedCreateWorkspaceRequest ............................................................................................................ 353 Contents ............................................................................................................................................... 353 See Also ................................................................................................................................................ 353 FailedWorkspaceChangeRequest ........................................................................................................... 354 Contents ............................................................................................................................................... 354 See Also ................................................................................................................................................ 354 GlobalAcceleratorForDirectory .............................................................................................................. 356 Contents ............................................................................................................................................... 356 See Also ................................................................................................................................................ 356 GlobalAcceleratorForWorkSpace ........................................................................................................... 357 Contents ............................................................................................................................................... 357 See Also ................................................................................................................................................ 357 IDCConﬁg ................................................................................................................................................... 358 Contents ............................................................................................................................................... 358 See Also ................................................................................................................................................ 358 API Version 2015-04-08 xxi Amazon WorkSpaces Service API Reference ImagePermission ...................................................................................................................................... 359 Contents ............................................................................................................................................... 359 See Also ................................................................................................................................................ 359 ImageResourceAssociation ..................................................................................................................... 360 Contents ............................................................................................................................................... 360 See Also ................................................................................................................................................ 361 IosClientBrandingAttributes ................................................................................................................... 362 Contents ............................................................................................................................................... 362 See Also ................................................................................................................................................ 365 IosImportClientBrandingAttributes ...................................................................................................... 366 Contents ............................................................................................................................................... 366 See Also ................................................................................................................................................ 369 IpRuleItem ................................................................................................................................................. 370 Contents ............................................................................................................................................... 370 See Also ................................................................................................................................................ 370 MicrosoftEntraConﬁg .............................................................................................................................. 371 Contents ............................................................................................................................................... 371 See Also ................................................................................................................................................ 371 ModiﬁcationState ..................................................................................................................................... 372 Contents ............................................................................................................................................... 372 See Also ................................................................................................................................................ 372 NetworkAccessConﬁguration ................................................................................................................. 373 Contents ............................................................................................................................................... 373 See Also ................................................................................................................................................ 373 OperatingSystem ..................................................................................................................................... 374 Contents ............................................................................................................................................... 374 See Also ................................................................................................................................................ 374 PendingCreateStandbyWorkspacesRequest ........................................................................................ 375 Contents ............................................................................................................................................... 375 See Also ................................................................................................................................................ 376 RebootRequest .......................................................................................................................................... 377 Contents ............................................................................................................................................... 377 See Also ................................................................................................................................................ 377 RebuildRequest ......................................................................................................................................... 378 Contents ............................................................................................................................................... 378 See Also ................................................................................................................................................ 378 API Version 2015-04-08
workspaces-api-005	workspaces-api.pdf	5	Contents ............................................................................................................................................... 362 See Also ................................................................................................................................................ 365 IosImportClientBrandingAttributes ...................................................................................................... 366 Contents ............................................................................................................................................... 366 See Also ................................................................................................................................................ 369 IpRuleItem ................................................................................................................................................. 370 Contents ............................................................................................................................................... 370 See Also ................................................................................................................................................ 370 MicrosoftEntraConﬁg .............................................................................................................................. 371 Contents ............................................................................................................................................... 371 See Also ................................................................................................................................................ 371 ModiﬁcationState ..................................................................................................................................... 372 Contents ............................................................................................................................................... 372 See Also ................................................................................................................................................ 372 NetworkAccessConﬁguration ................................................................................................................. 373 Contents ............................................................................................................................................... 373 See Also ................................................................................................................................................ 373 OperatingSystem ..................................................................................................................................... 374 Contents ............................................................................................................................................... 374 See Also ................................................................................................................................................ 374 PendingCreateStandbyWorkspacesRequest ........................................................................................ 375 Contents ............................................................................................................................................... 375 See Also ................................................................................................................................................ 376 RebootRequest .......................................................................................................................................... 377 Contents ............................................................................................................................................... 377 See Also ................................................................................................................................................ 377 RebuildRequest ......................................................................................................................................... 378 Contents ............................................................................................................................................... 378 See Also ................................................................................................................................................ 378 API Version 2015-04-08 xxii Amazon WorkSpaces Service API Reference RelatedWorkspaceProperties ................................................................................................................. 379 Contents ............................................................................................................................................... 379 See Also ................................................................................................................................................ 380 RootStorage .............................................................................................................................................. 381 Contents ............................................................................................................................................... 381 See Also ................................................................................................................................................ 381 SamlProperties ......................................................................................................................................... 382 Contents ............................................................................................................................................... 382 See Also ................................................................................................................................................ 383 SelfservicePermissions ............................................................................................................................ 384 Contents ............................................................................................................................................... 384 See Also ................................................................................................................................................ 385 Snapshot .................................................................................................................................................... 386 Contents ............................................................................................................................................... 386 See Also ................................................................................................................................................ 386 StandbyWorkspace ................................................................................................................................... 387 Contents ............................................................................................................................................... 387 See Also ................................................................................................................................................ 388 StandbyWorkspacesProperties .............................................................................................................. 389 Contents ............................................................................................................................................... 389 See Also ................................................................................................................................................ 389 StartRequest .............................................................................................................................................. 391 Contents ............................................................................................................................................... 391 See Also ................................................................................................................................................ 391 StopRequest .............................................................................................................................................. 392 Contents ............................................................................................................................................... 392 See Also ................................................................................................................................................ 392 StorageConnector .................................................................................................................................... 393 Contents ............................................................................................................................................... 393 See Also ................................................................................................................................................ 393 StreamingProperties ................................................................................................................................ 394 Contents ............................................................................................................................................... 394 See Also ................................................................................................................................................ 395 Tag ............................................................................................................................................................... 396 Contents ............................................................................................................................................... 396 See Also ................................................................................................................................................ 396 API Version 2015-04-08 xxiii Amazon WorkSpaces Service API Reference TerminateRequest .................................................................................................................................... 397 Contents ............................................................................................................................................... 397 See Also ................................................................................................................................................ 397 TimeoutSettings ....................................................................................................................................... 398 Contents ............................................................................................................................................... 398 See Also ................................................................................................................................................ 399 UpdateResult ............................................................................................................................................. 400 Contents ............................................................................................................................................... 400 See Also ................................................................................................................................................ 400 UserSetting ................................................................................................................................................ 402 Contents ............................................................................................................................................... 402 See Also ................................................................................................................................................ 402 UserStorage ............................................................................................................................................... 404 Contents ............................................................................................................................................... 404 See Also ................................................................................................................................................ 404 Workspace .................................................................................................................................................. 405 Contents ............................................................................................................................................... 405 See Also ................................................................................................................................................ 409 WorkspaceAccessProperties ................................................................................................................... 411 Contents ............................................................................................................................................... 411 See Also ................................................................................................................................................ 413 WorkSpaceApplication ............................................................................................................................ 414 Contents ............................................................................................................................................... 414 See Also ................................................................................................................................................ 416 WorkSpaceApplicationDeployment ...................................................................................................... 417 Contents ............................................................................................................................................... 417 See Also ................................................................................................................................................ 417 WorkspaceBundle ..................................................................................................................................... 418 Contents ............................................................................................................................................... 418 See Also ................................................................................................................................................ 420 WorkspaceConnectionStatus ................................................................................................................. 421 Contents ............................................................................................................................................... 421 See Also ................................................................................................................................................ 422 WorkspaceCreationProperties ................................................................................................................ 423 Contents ............................................................................................................................................... 423 See Also ................................................................................................................................................ 424 API Version 2015-04-08 xxiv Amazon WorkSpaces Service API Reference WorkspaceDirectory ................................................................................................................................. 425 Contents ............................................................................................................................................... 425 See Also ................................................................................................................................................ 431 WorkspaceImage ...................................................................................................................................... 432 Contents ............................................................................................................................................... 432 See Also ................................................................................................................................................ 434 WorkspaceProperties ............................................................................................................................... 435 Contents ............................................................................................................................................... 435 See Also ................................................................................................................................................ 437 WorkspaceRequest ................................................................................................................................... 438 Contents ............................................................................................................................................... 438 See Also ................................................................................................................................................ 440 WorkspaceResourceAssociation ............................................................................................................. 441 Contents ............................................................................................................................................... 441 See Also ................................................................................................................................................ 442 WorkspacesIpGroup ................................................................................................................................. 443 Contents ............................................................................................................................................... 443 See Also ................................................................................................................................................ 443 WorkspacesPool ........................................................................................................................................ 445 Contents ............................................................................................................................................... 445 See Also ................................................................................................................................................ 447 WorkspacesPoolError ............................................................................................................................... 449 Contents ............................................................................................................................................... 449 See Also ................................................................................................................................................ 450 WorkspacesPoolSession .......................................................................................................................... 451 Contents ............................................................................................................................................... 451 See Also ................................................................................................................................................ 453 Common Errors ............................................................................................................................ 454 WorkSpaces Core API actions ..................................................................................................... 456 CloudTrail Logging ...................................................................................................................... 459 WorkSpaces Information in CloudTrail ................................................................................................ 459 Example: WorkSpaces Log File Entry .................................................................................................. 460 API Version 2015-04-08 xxv Amazon WorkSpaces Service API Reference Welcome to the Amazon WorkSpaces API Reference Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers. This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported AWS Regions, endpoints, and service quotas of the WorkSpaces service, see WorkSpaces endpoints and quotas in the AWS General Reference. You can also manage your WorkSpaces resources using the WorkSpaces console, AWS Command Line Interface (AWS CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the AWS CLI to manage your WorkSpaces resources, see the WorkSpaces section of the AWS CLI Reference. API Version 2015-04-08 1 Amazon WorkSpaces Service API Reference Actions The following actions are supported: • AcceptAccountLinkInvitation • AssociateConnectionAlias • AssociateIpGroups • AssociateWorkspaceApplication • AuthorizeIpRules • CopyWorkspaceImage • CreateAccountLinkInvitation • CreateConnectClientAddIn • CreateConnectionAlias • CreateIpGroup • CreateStandbyWorkspaces • CreateTags • CreateUpdatedWorkspaceImage • CreateWorkspaceBundle • CreateWorkspaceImage • CreateWorkspaces • CreateWorkspacesPool • DeleteAccountLinkInvitation • DeleteClientBranding • DeleteConnectClientAddIn • DeleteConnectionAlias • DeleteIpGroup • DeleteTags • DeleteWorkspaceBundle • DeleteWorkspaceImage • DeployWorkspaceApplications • DeregisterWorkspaceDirectory API Version 2015-04-08 2 Amazon WorkSpaces Service • DescribeAccount • DescribeAccountModiﬁcations • DescribeApplicationAssociations • DescribeApplications • DescribeBundleAssociations • DescribeClientBranding • DescribeClientProperties • DescribeConnectClientAddIns • DescribeConnectionAliases • DescribeConnectionAliasPermissions • DescribeImageAssociations • DescribeIpGroups • DescribeTags • DescribeWorkspaceAssociations • DescribeWorkspaceBundles • DescribeWorkspaceDirectories • DescribeWorkspaceImagePermissions • DescribeWorkspaceImages • DescribeWorkspaces • DescribeWorkspacesConnectionStatus • DescribeWorkspaceSnapshots • DescribeWorkspacesPools • DescribeWorkspacesPoolSessions • DisassociateConnectionAlias • DisassociateIpGroups •
workspaces-api-006	workspaces-api.pdf	6	• CreateAccountLinkInvitation • CreateConnectClientAddIn • CreateConnectionAlias • CreateIpGroup • CreateStandbyWorkspaces • CreateTags • CreateUpdatedWorkspaceImage • CreateWorkspaceBundle • CreateWorkspaceImage • CreateWorkspaces • CreateWorkspacesPool • DeleteAccountLinkInvitation • DeleteClientBranding • DeleteConnectClientAddIn • DeleteConnectionAlias • DeleteIpGroup • DeleteTags • DeleteWorkspaceBundle • DeleteWorkspaceImage • DeployWorkspaceApplications • DeregisterWorkspaceDirectory API Version 2015-04-08 2 Amazon WorkSpaces Service • DescribeAccount • DescribeAccountModiﬁcations • DescribeApplicationAssociations • DescribeApplications • DescribeBundleAssociations • DescribeClientBranding • DescribeClientProperties • DescribeConnectClientAddIns • DescribeConnectionAliases • DescribeConnectionAliasPermissions • DescribeImageAssociations • DescribeIpGroups • DescribeTags • DescribeWorkspaceAssociations • DescribeWorkspaceBundles • DescribeWorkspaceDirectories • DescribeWorkspaceImagePermissions • DescribeWorkspaceImages • DescribeWorkspaces • DescribeWorkspacesConnectionStatus • DescribeWorkspaceSnapshots • DescribeWorkspacesPools • DescribeWorkspacesPoolSessions • DisassociateConnectionAlias • DisassociateIpGroups • DisassociateWorkspaceApplication • GetAccountLink • ImportClientBranding • ImportWorkspaceImage • ListAccountLinks API Reference API Version 2015-04-08 3 Amazon WorkSpaces Service API Reference • ListAvailableManagementCidrRanges • MigrateWorkspace • ModifyAccount • ModifyCertiﬁcateBasedAuthProperties • ModifyClientProperties • ModifyEndpointEncryptionMode • ModifySamlProperties • ModifySelfservicePermissions • ModifyStreamingProperties • ModifyWorkspaceAccessProperties • ModifyWorkspaceCreationProperties • ModifyWorkspaceProperties • ModifyWorkspaceState • RebootWorkspaces • RebuildWorkspaces • RegisterWorkspaceDirectory • RejectAccountLinkInvitation • RestoreWorkspace • RevokeIpRules • StartWorkspaces • StartWorkspacesPool • StopWorkspaces • StopWorkspacesPool • TerminateWorkspaces • TerminateWorkspacesPool • TerminateWorkspacesPoolSession • UpdateConnectClientAddIn • UpdateConnectionAliasPermission • UpdateRulesOfIpGroup • UpdateWorkspaceBundle API Version 2015-04-08 4 Amazon WorkSpaces Service API Reference • UpdateWorkspaceImagePermission • UpdateWorkspacesPool API Version 2015-04-08 5 Amazon WorkSpaces Service API Reference AcceptAccountLinkInvitation Accepts the account link invitation. Important There's currently no unlinking capability after you accept the account linking invitation. Request Syntax { "ClientToken": "string", "LinkId": "string" } Request Parameters The request accepts the following data in JSON format. ClientToken A string of up to 64 ASCII characters that Amazon WorkSpaces uses to ensure idempotent creation. Type: String Pattern: ^.{1,64}$ Required: No LinkId The identiﬁer of the account link. Type: String Pattern: ^link-.{8,24}$ Required: Yes AcceptAccountLinkInvitation API Version 2015-04-08 6 API Reference Amazon WorkSpaces Service Response Syntax { "AccountLink": { "AccountLinkId": "string", "AccountLinkStatus": "string", "SourceAccountId": "string", "TargetAccountId": "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. AccountLink Information about the account link. Type: AccountLink 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 ConﬂictException The TargetAccountId is already linked or invited. HTTP Status Code: 400 InternalServerException Unexpected server error occured. Response Syntax API Version 2015-04-08 7 Amazon WorkSpaces Service HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 ValidationException API Reference You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 8 Amazon WorkSpaces Service API Reference AssociateConnectionAlias Associates the speciﬁed connection alias with the speciﬁed directory to enable cross-Region redirection. 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. Request Syntax { "AliasId": "string", "ResourceId": "string" } Request Parameters The request accepts the following data in JSON format. AliasId The identiﬁer of the connection alias. Type: String Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: ^wsca-[0-9a-z]{8,63}$ Required: Yes ResourceId The identiﬁer of the directory to associate the connection alias with. Type: String Length Constraints: Minimum length of 1. AssociateConnectionAlias API Version 2015-04-08 9 API Reference Amazon WorkSpaces Service Required: Yes Response Syntax { "ConnectionIdentifier": "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. ConnectionIdentiﬁer The identiﬁer of the connection alias association. You use the connection identiﬁer in the DNS TXT record when you're conﬁguring your DNS routing policies. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: ^[a-zA-Z0-9]+$ 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 Syntax API Version 2015-04-08 10 Amazon WorkSpaces Service InvalidResourceStateException The state of the resource is not valid for this operation. API Reference HTTP Status Code: 400 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceAssociatedException The resource is associated with a directory. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found.
workspaces-api-007	workspaces-api.pdf	7	Pattern: ^[a-zA-Z0-9]+$ 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 Syntax API Version 2015-04-08 10 Amazon WorkSpaces Service InvalidResourceStateException The state of the resource is not valid for this operation. API Reference HTTP Status Code: 400 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceAssociatedException The resource is associated with a directory. 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-speciﬁc 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 11 Amazon WorkSpaces Service AssociateIpGroups API Reference Associates the speciﬁed IP access control group with the speciﬁed directory. Request Syntax { "DirectoryId": "string", "GroupIds": [ "string" ] } Request Parameters The request accepts the following data in JSON format. DirectoryId The identiﬁer 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: Yes GroupIds The identiﬁers of one or more IP access control groups. Type: Array of strings Pattern: wsipg-[0-9a-z]{8,63}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. AssociateIpGroups API Version 2015-04-08 12 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 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-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2015-04-08 13 API Reference Amazon WorkSpaces Service • 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 14 Amazon WorkSpaces Service API Reference AssociateWorkspaceApplication Associates the speciﬁed application to the speciﬁed WorkSpace. Request Syntax { "ApplicationId": "string", "WorkspaceId": "string" } Request Parameters The request accepts the following data in JSON format. ApplicationId The identiﬁer of the application. Type: String Pattern: ^wsa-[0-9a-z]{8,63}$ Required: Yes WorkspaceId The identiﬁer of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: Yes Response Syntax { "Association": { "AssociatedResourceId": "string", "AssociatedResourceType": "string", "Created": number, AssociateWorkspaceApplication API Version 2015-04-08 15 Amazon WorkSpaces Service API Reference "LastUpdatedTime": number, "State": "string", "StateReason": { "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. Association Information about the association between the speciﬁed WorkSpace and the speciﬁed application. Type: WorkspaceResourceAssociation 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 ApplicationNotSupportedException The speciﬁed application is not supported. HTTP Status Code: 400 ComputeNotCompatibleException The compute type of the WorkSpace is not compatible with the application. HTTP Status Code: 400 Response Elements API Version 2015-04-08 16 Amazon WorkSpaces Service API Reference IncompatibleApplicationsException The speciﬁed application is not compatible with the resource. HTTP Status Code: 400 InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 OperatingSystemNotCompatibleException The operating system of the WorkSpace is not compatible with the application. HTTP Status Code: 400 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceAlreadyExistsException The speciﬁed resource already exists. HTTP Status Code: 400 ResourceInUseException The speciﬁed resource is currently in use. 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-speciﬁc AWS SDKs, see the following: See Also API Version 2015-04-08 17 API Reference Amazon WorkSpaces Service • AWS Command Line Interface • AWS
workspaces-api-008	workspaces-api.pdf	8	Status Code: 400 OperatingSystemNotCompatibleException The operating system of the WorkSpace is not compatible with the application. HTTP Status Code: 400 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceAlreadyExistsException The speciﬁed resource already exists. HTTP Status Code: 400 ResourceInUseException The speciﬁed resource is currently in use. 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-speciﬁc AWS SDKs, see the following: See Also API Version 2015-04-08 17 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 18 Amazon WorkSpaces Service AuthorizeIpRules API Reference Adds one or more rules to the speciﬁed IP access control group. This action gives users permission to access their WorkSpaces from the CIDR address ranges speciﬁed in the rules. Request Syntax { "GroupId": "string", "UserRules": [ { "ipRule": "string", "ruleDesc": "string" } ] } Request Parameters The request accepts the following data in JSON format. GroupId The identiﬁer of the group. Type: String Pattern: wsipg-[0-9a-z]{8,63}$ Required: Yes UserRules The rules to add to the group. Type: Array of IpRuleItem objects Required: Yes AuthorizeIpRules API Version 2015-04-08 19 Amazon WorkSpaces Service 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 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-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Response Elements API Version 2015-04-08 20 API Reference Amazon WorkSpaces Service • 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 21 Amazon WorkSpaces Service API Reference CopyWorkspaceImage Copies the speciﬁed image from the speciﬁed Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image. 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. Important Before copying a shared image, be sure to verify that it has been shared from the correct AWS account. To determine if an image has been shared and to see the ID of the AWS account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations. Request Syntax { "Description": "string", "Name": "string", "SourceImageId": "string", "SourceRegion": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters The request accepts the following data in JSON format. Description A description of the image. Type: String CopyWorkspaceImage API Version 2015-04-08 22 Amazon WorkSpaces Service API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9_./() -]+$ 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: Yes SourceImageId The identiﬁer of the source image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ Required: Yes SourceRegion The identiﬁer of the source Region. Type: String Length Constraints: Minimum length of 1. Maximum length of 31. Pattern: ^[-0-9a-z]{1,31}$ Required: Yes Tags The tags for the image. Type: Array of Tag objects Request Parameters API Version 2015-04-08 23 API Reference Amazon WorkSpaces Service Required: No Response Syntax { "ImageId": "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. ImageId The identiﬁer of the image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ 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. Response Syntax API Version 2015-04-08 24 API Reference Amazon WorkSpaces Service HTTP Status
workspaces-api-009	workspaces-api.pdf	9	"ImageId": "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. ImageId The identiﬁer of the image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ 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. Response Syntax API Version 2015-04-08 24 API Reference Amazon WorkSpaces Service HTTP Status Code: 400 ResourceAlreadyExistsException The speciﬁed resource already exists. 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 ResourceUnavailableException The speciﬁed resource is not available. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 25 Amazon WorkSpaces Service API Reference See Also API Version 2015-04-08 26 Amazon WorkSpaces Service API Reference CreateAccountLinkInvitation Creates the account link invitation. Request Syntax { "ClientToken": "string", "TargetAccountId": "string" } Request Parameters The request accepts the following data in JSON format. ClientToken A string of up to 64 ASCII characters that Amazon WorkSpaces uses to ensure idempotent creation. Type: String Pattern: ^.{1,64}$ Required: No TargetAccountId The identiﬁer of the target account. Type: String Pattern: ^\d{12}$ Required: Yes Response Syntax { "AccountLink": { "AccountLinkId": "string", CreateAccountLinkInvitation API Version 2015-04-08 27 Amazon WorkSpaces Service API Reference "AccountLinkStatus": "string", "SourceAccountId": "string", "TargetAccountId": "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. AccountLink Information about the account link. Type: AccountLink 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 ConﬂictException The TargetAccountId is already linked or invited. HTTP Status Code: 400 InternalServerException Unexpected server error occured. HTTP Status Code: 400 ValidationException You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId. Response Elements API Version 2015-04-08 28 Amazon WorkSpaces Service HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc 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 29 Amazon WorkSpaces Service API Reference CreateConnectClientAddIn Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory. This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect. Request Syntax { "Name": "string", "ResourceId": "string", "URL": "string" } Request Parameters The request accepts the following data in JSON format. Name The name of the client add-in. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^.*$ Required: Yes ResourceId The directory identiﬁer for which to conﬁgure the client add-in. 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 CreateConnectClientAddIn API Version 2015-04-08 30 Amazon WorkSpaces Service URL API Reference 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: Yes Response Syntax { "AddInId": "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. AddInId The client add-in identiﬁer. 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} 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. Response Syntax API Version 2015-04-08 31 API Reference Amazon WorkSpaces Service HTTP Status Code: 400 InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 ResourceAlreadyExistsException The speciﬁed resource already exists. HTTP Status Code: 400 ResourceCreationFailedException The resource could not be created. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status
workspaces-api-010	workspaces-api.pdf	10	the service. AddInId The client add-in identiﬁer. 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} 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. Response Syntax API Version 2015-04-08 31 API Reference Amazon WorkSpaces Service HTTP Status Code: 400 InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 ResourceAlreadyExistsException The speciﬁed resource already exists. HTTP Status Code: 400 ResourceCreationFailedException The resource could not be created. 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-speciﬁc 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 32 Amazon WorkSpaces Service API Reference See Also API Version 2015-04-08 33 Amazon WorkSpaces Service API Reference CreateConnectionAlias Creates the speciﬁed connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Request Syntax { "ConnectionString": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters The request accepts the following data in JSON format. ConnectionString A connection string in the form of a fully qualiﬁed domain name (FQDN), such as www.example.com. Important After you create a connection string, it is always associated to your AWS account. You cannot recreate the same connection string with a diﬀerent account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[.0-9a-zA-Z\-]{1,255}$ CreateConnectionAlias API Version 2015-04-08 34 Amazon WorkSpaces Service Required: Yes Tags The tags to associate with the connection alias. API Reference Type: Array of Tag objects Required: No Response Syntax { "AliasId": "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. AliasId The identiﬁer of the connection alias. Type: String Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: ^wsca-[0-9a-z]{8,63}$ 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 Response Syntax API Version 2015-04-08 35 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 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceAlreadyExistsException The speciﬁed resource already exists. HTTP Status Code: 400 ResourceLimitExceededException Your resource limits have been exceeded. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 36 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 37 Amazon WorkSpaces Service CreateIpGroup Creates an IP access control group. API Reference An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules. There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory. Request Syntax { "GroupDesc": "string", "GroupName": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "UserRules": [ { "ipRule": "string", "ruleDesc": "string" } ] } Request Parameters The request accepts the following data in JSON format. GroupDesc The description of the group. CreateIpGroup API Version 2015-04-08 38 API Reference Amazon WorkSpaces Service Type: String Required: No GroupName The name of the group. Type: String Required: Yes Tags The tags. Each WorkSpaces resource can have a
workspaces-api-011	workspaces-api.pdf	11	a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory. Request Syntax { "GroupDesc": "string", "GroupName": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "UserRules": [ { "ipRule": "string", "ruleDesc": "string" } ] } Request Parameters The request accepts the following data in JSON format. GroupDesc The description of the group. CreateIpGroup API Version 2015-04-08 38 API Reference Amazon WorkSpaces Service Type: String Required: No GroupName The name of the group. Type: String Required: Yes Tags The tags. Each WorkSpaces resource can have a maximum of 50 tags. Type: Array of Tag objects Required: No UserRules The rules to add to the group. Type: Array of IpRuleItem objects Required: No Response Syntax { "GroupId": "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. GroupId The identiﬁer of the group. Response Syntax API Version 2015-04-08 39 Amazon WorkSpaces Service Type: String Pattern: wsipg-[0-9a-z]{8,63}$ 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 ResourceAlreadyExistsException The speciﬁed resource already exists. HTTP Status Code: 400 ResourceCreationFailedException The resource could not be created. HTTP Status Code: 400 ResourceLimitExceededException Your resource limits have been exceeded. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2015-04-08 40 API Reference Amazon WorkSpaces Service • 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 41 Amazon WorkSpaces Service API Reference CreateStandbyWorkspaces Creates a standby WorkSpace in a secondary Region. Request Syntax { "PrimaryRegion": "string", "StandbyWorkspaces": [ { "DataReplication": "string", "DirectoryId": "string", "PrimaryWorkspaceId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeEncryptionKey": "string" } ] } Request Parameters The request accepts the following data in JSON format. PrimaryRegion The Region of the primary WorkSpace. Type: String Length Constraints: Minimum length of 1. Maximum length of 31. Pattern: ^[-0-9a-z]{1,31}$ Required: Yes StandbyWorkspaces Information about the standby WorkSpace to be created. CreateStandbyWorkspaces API Version 2015-04-08 42 Amazon WorkSpaces Service API Reference Type: Array of StandbyWorkspace objects Required: Yes Response Syntax { "FailedStandbyRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "StandbyWorkspaceRequest": { "DataReplication": "string", "DirectoryId": "string", "PrimaryWorkspaceId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeEncryptionKey": "string" } } ], "PendingStandbyRequests": [ { "DirectoryId": "string", "State": "string", "UserName": "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. Response Syntax API Version 2015-04-08 43 Amazon WorkSpaces Service FailedStandbyRequests API Reference Information about the standby WorkSpace that could not be created. Type: Array of FailedCreateStandbyWorkspacesRequest objects PendingStandbyRequests Information about the standby WorkSpace that was created. Type: Array of PendingCreateStandbyWorkspacesRequest objects 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 ResourceLimitExceededException Your resource limits have been exceeded. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 Errors API Version 2015-04-08 44 Amazon WorkSpaces Service See Also API Reference For more information about using this API in one of the language-speciﬁc 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 45 Amazon WorkSpaces Service CreateTags Creates the speciﬁed tags for the speciﬁed WorkSpaces resource. API Reference Request Syntax { "ResourceId": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters The request accepts the following data in JSON format. ResourceId The identiﬁer of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases. Type: String Length Constraints: Minimum length of 1. Required: Yes Tags The
workspaces-api-012	workspaces-api.pdf	12	AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2015-04-08 45 Amazon WorkSpaces Service CreateTags Creates the speciﬁed tags for the speciﬁed WorkSpaces resource. API Reference Request Syntax { "ResourceId": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters The request accepts the following data in JSON format. ResourceId The identiﬁer of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases. Type: String Length Constraints: Minimum length of 1. Required: Yes Tags The tags. Each WorkSpaces resource can have a maximum of 50 tags. Type: Array of Tag objects Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. CreateTags API Version 2015-04-08 46 Amazon WorkSpaces Service Errors API Reference For information about the errors that are common to all actions, see Common Errors. InvalidParameterValuesException One or more parameter values are not valid. 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-speciﬁc 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 47 Amazon WorkSpaces Service API Reference CreateUpdatedWorkspaceImage Creates a new updated WorkSpace image based on the speciﬁed source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components. To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages. Note • Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time. • Microsoft Windows updates and other application updates are not included in the update process. • The source WorkSpace image is not deleted. You can delete the source image after you've veriﬁed your new updated image and created a new bundle. Request Syntax { "Description": "string", "Name": "string", "SourceImageId": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters The request accepts the following data in JSON format. CreateUpdatedWorkspaceImage API Version 2015-04-08 48 Amazon WorkSpaces Service Description API Reference A description of whether updates for the WorkSpace image are available. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9_./() -]+$ Required: Yes Name The name of the new updated WorkSpace image. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[a-zA-Z0-9_./()\\-]+$ Required: Yes SourceImageId The identiﬁer of the source WorkSpace image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ Required: Yes Tags The tags that you want to add to the new updated WorkSpace image. Note To add tags at the same time when you're creating the updated image, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags. Type: Array of Tag objects Request Parameters API Version 2015-04-08 49 API Reference Amazon WorkSpaces Service Required: No Response Syntax { "ImageId": "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. ImageId The identiﬁer of the new updated WorkSpace image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ 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 Syntax API Version 2015-04-08 50 API Reference Amazon WorkSpaces Service HTTP Status Code: 400 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceAlreadyExistsException The speciﬁed resource already exists. 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-speciﬁc 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 51 Amazon WorkSpaces Service
workspaces-api-013	workspaces-api.pdf	13	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-speciﬁc 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 51 Amazon WorkSpaces Service API Reference See Also API Version 2015-04-08 52 Amazon WorkSpaces Service API Reference CreateWorkspaceBundle Creates the speciﬁed WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle. Request Syntax { "BundleDescription": "string", "BundleName": "string", "ComputeType": { "Name": "string" }, "ImageId": "string", "RootStorage": { "Capacity": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "UserStorage": { "Capacity": "string" } } Request Parameters The request accepts the following data in JSON format. BundleDescription The description of the bundle. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[a-zA-Z0-9_./() -]+$ Required: Yes CreateWorkspaceBundle API Version 2015-04-08 53 API Reference Amazon WorkSpaces Service BundleName The name of the bundle. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[a-zA-Z0-9_./()\\-]+$ Required: Yes ComputeType Describes the compute type of the bundle. Type: ComputeType object Required: Yes ImageId The identiﬁer of the image that is used to create the bundle. Type: String Pattern: wsi-[0-9a-z]{9,63}$ Required: Yes RootStorage Describes the root volume for a WorkSpace bundle. Type: RootStorage object Required: No Tags The tags associated with the bundle. Note To add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags. Request Parameters API Version 2015-04-08 54 Amazon WorkSpaces Service Type: Array of Tag objects Required: No UserStorage Describes the user volume for a WorkSpace bundle. API Reference Type: UserStorage object Required: Yes Response Syntax { "WorkspaceBundle": { "BundleId": "string", "BundleType": "string", "ComputeType": { "Name": "string" }, "CreationTime": number, "Description": "string", "ImageId": "string", "LastUpdatedTime": number, "Name": "string", "Owner": "string", "RootStorage": { "Capacity": "string" }, "State": "string", "UserStorage": { "Capacity": "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. Response Syntax API Version 2015-04-08 55 API Reference Amazon WorkSpaces Service WorkspaceBundle Describes a WorkSpace bundle. Type: WorkspaceBundle 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 ResourceAlreadyExistsException The speciﬁed resource already exists. 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 ResourceUnavailableException The speciﬁed resource is not available. HTTP Status Code: 400 Errors API Version 2015-04-08 56 Amazon WorkSpaces Service See Also API Reference For more information about using this API in one of the language-speciﬁc 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 57 Amazon WorkSpaces Service API Reference CreateWorkspaceImage Creates a new WorkSpace image from an existing WorkSpace. Request Syntax { "Description": "string", "Name": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "WorkspaceId": "string" } Request Parameters The request accepts the following data in JSON format. Description The description of the new WorkSpace image. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9_./() -]+$ Required: Yes Name The name of the new WorkSpace image. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[a-zA-Z0-9_./()\\-]+$ CreateWorkspaceImage API Version 2015-04-08 58 Amazon WorkSpaces Service Required: Yes Tags API Reference The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags. Type: Array of Tag objects Required: No WorkspaceId The identiﬁer of the source WorkSpace Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: Yes Response Syntax { "Created": number, "Description": "string", "ImageId": "string", "Name": "string", "OperatingSystem": { "Type": "string" }, "OwnerAccountId": "string", "RequiredTenancy": "string", "State": "string" } Response Elements If the action is successful, the service sends
workspaces-api-014	workspaces-api.pdf	14	API Version 2015-04-08 58 Amazon WorkSpaces Service Required: Yes Tags API Reference The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags. Type: Array of Tag objects Required: No WorkspaceId The identiﬁer of the source WorkSpace Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: Yes Response Syntax { "Created": number, "Description": "string", "ImageId": "string", "Name": "string", "OperatingSystem": { "Type": "string" }, "OwnerAccountId": "string", "RequiredTenancy": "string", "State": "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. Response Syntax API Version 2015-04-08 59 API Reference Amazon WorkSpaces Service Created The date when the image was created. Type: Timestamp Description The description of the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9_./() -]+$ ImageId The identiﬁer of the new WorkSpace image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ Name The name of the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[a-zA-Z0-9_./()\\-]+$ OperatingSystem The operating system that the image is running. Type: OperatingSystem object OwnerAccountId The identiﬁer of the AWS account that owns the image. Type: String Pattern: ^\d{12}$ Response Elements API Version 2015-04-08 60 Amazon WorkSpaces Service RequiredTenancy API Reference Speciﬁes 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 State The availability status of the image. Type: String Valid Values: AVAILABLE \| PENDING \| ERROR 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 Errors API Version 2015-04-08 61 API Reference Amazon WorkSpaces Service ResourceAlreadyExistsException The speciﬁed resource already exists. 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-speciﬁc 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 62 Amazon WorkSpaces Service CreateWorkspaces Creates one or more WorkSpaces. API Reference This operation is asynchronous and returns before the WorkSpaces are created. Note • The MANUAL running mode 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. • You don't need to specify the PCOIP protocol for Linux bundles because DCV (formerly WSP) is the default protocol for those bundles. • User-decoupled WorkSpaces are only supported by 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? Request Syntax { "Workspaces": [ { "BundleId": "string", "DirectoryId": "string", "RootVolumeEncryptionEnabled": boolean, "Tags": [ { "Key": "string", "Value": "string" } ], "UserName": "string", "UserVolumeEncryptionEnabled": boolean, "VolumeEncryptionKey": "string", "WorkspaceName": "string", "WorkspaceProperties": { "ComputeTypeName": "string", CreateWorkspaces API Version 2015-04-08 63 Amazon WorkSpaces Service API Reference "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "OperatingSystemName": "string", "Protocols": [ "string" ], "RootVolumeSizeGib": number, "RunningMode": "string", "RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": number } } ] } Request Parameters The request accepts the following data in JSON format. Workspaces The WorkSpaces to create. You can specify up to 25 WorkSpaces. Type: Array of WorkspaceRequest objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: Yes Response Syntax { "FailedRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "WorkspaceRequest": { "BundleId": "string", "DirectoryId": "string", "RootVolumeEncryptionEnabled": boolean, "Tags": [ { "Key": "string", Request Parameters API Version 2015-04-08 64 Amazon WorkSpaces Service API Reference "Value": "string" } ], "UserName": "string", "UserVolumeEncryptionEnabled": boolean, "VolumeEncryptionKey": "string", "WorkspaceName": "string", "WorkspaceProperties": { "ComputeTypeName": "string", "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "OperatingSystemName": "string", "Protocols": [ "string" ], "RootVolumeSizeGib": number, "RunningMode": "string", "RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": number } } } ], "PendingRequests": [ { "BundleId": "string", "ComputerName": "string", "DataReplicationSettings": { "DataReplication": "string", "RecoverySnapshotTime": number }, "DirectoryId": "string", "ErrorCode": "string",
workspaces-api-015	workspaces-api.pdf	15	Maximum number of 25 items. Required: Yes Response Syntax { "FailedRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "WorkspaceRequest": { "BundleId": "string", "DirectoryId": "string", "RootVolumeEncryptionEnabled": boolean, "Tags": [ { "Key": "string", Request Parameters API Version 2015-04-08 64 Amazon WorkSpaces Service API Reference "Value": "string" } ], "UserName": "string", "UserVolumeEncryptionEnabled": boolean, "VolumeEncryptionKey": "string", "WorkspaceName": "string", "WorkspaceProperties": { "ComputeTypeName": "string", "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "OperatingSystemName": "string", "Protocols": [ "string" ], "RootVolumeSizeGib": number, "RunningMode": "string", "RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": number } } } ], "PendingRequests": [ { "BundleId": "string", "ComputerName": "string", "DataReplicationSettings": { "DataReplication": "string", "RecoverySnapshotTime": number }, "DirectoryId": "string", "ErrorCode": "string", "ErrorMessage": "string", "IpAddress": "string", "ModificationStates": [ { "Resource": "string", "State": "string" } ], "RelatedWorkspaces": [ { "Region": "string", Response Syntax API Version 2015-04-08 65 Amazon WorkSpaces Service API Reference "State": "string", "Type": "string", "WorkspaceId": "string" } ], "RootVolumeEncryptionEnabled": boolean, "StandbyWorkspacesProperties": [ { "DataReplication": "string", "RecoverySnapshotTime": number, "StandbyWorkspaceId": "string" } ], "State": "string", "SubnetId": "string", "UserName": "string", "UserVolumeEncryptionEnabled": boolean, "VolumeEncryptionKey": "string", "WorkspaceId": "string", "WorkspaceName": "string", "WorkspaceProperties": { "ComputeTypeName": "string", "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "OperatingSystemName": "string", "Protocols": [ "string" ], "RootVolumeSizeGib": number, "RunningMode": "string", "RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": 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. Response Elements API Version 2015-04-08 66 Amazon WorkSpaces Service FailedRequests API Reference Information about the WorkSpaces that could not be created. Type: Array of FailedCreateWorkspaceRequest objects PendingRequests Information about the WorkSpaces that were created. Because this operation is asynchronous, the identiﬁer 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: Array of Workspace objects Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 ResourceLimitExceededException Your resource limits have been exceeded. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 67 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 68 Amazon WorkSpaces Service API Reference CreateWorkspacesPool Creates a pool of WorkSpaces. Request Syntax { "ApplicationSettings": { "SettingsGroup": "string", "Status": "string" }, "BundleId": "string", "Capacity": { "DesiredUserSessions": number }, "Description": "string", "DirectoryId": "string", "PoolName": "string", "RunningMode": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TimeoutSettings": { "DisconnectTimeoutInSeconds": number, "IdleDisconnectTimeoutInSeconds": number, "MaxUserDurationInSeconds": number } } Request Parameters The request accepts the following data in JSON format. ApplicationSettings Indicates the application settings of the pool. Type: ApplicationSettingsRequest object Required: No CreateWorkspacesPool API Version 2015-04-08 69 API Reference Amazon WorkSpaces Service BundleId The identiﬁer of the bundle for the pool. Type: String Pattern: ^wsb-[0-9a-z]{8,63}$ Required: Yes Capacity The user capacity of the pool. Type: Capacity object Required: Yes Description The pool description. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[a-zA-Z0-9_./() -]+$ Required: Yes DirectoryId The identiﬁer of the directory for 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 PoolName The name of the pool. Type: String Request Parameters API Version 2015-04-08 70 Amazon WorkSpaces Service API Reference Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$ Required: Yes RunningMode The running mode for the pool. Type: String Valid Values: AUTO_STOP \| ALWAYS_ON Required: No Tags The tags for the pool. Type: Array of Tag objects Required: No TimeoutSettings Indicates the timeout settings of the 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 Response Syntax API Version 2015-04-08 71 Amazon WorkSpaces Service API Reference }, "CreatedAt": number, "Description": "string", "DirectoryId": "string", "Errors": [ { "ErrorCode": "string", "ErrorMessage": "string" } ], "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 Indicates the pool to create. 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. Response Elements API Version 2015-04-08 72 API Reference Amazon WorkSpaces Service HTTP Status Code: 400 InvalidParameterValuesException One or
workspaces-api-016	workspaces-api.pdf	16	], "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 Indicates the pool to create. 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. Response Elements API Version 2015-04-08 72 API Reference Amazon WorkSpaces Service 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 ResourceAlreadyExistsException The speciﬁed resource already exists. 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-speciﬁc 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 See Also API Version 2015-04-08 73 Amazon WorkSpaces Service • 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 74 Amazon WorkSpaces Service API Reference DeleteAccountLinkInvitation Deletes the account link invitation. Request Syntax { "ClientToken": "string", "LinkId": "string" } Request Parameters The request accepts the following data in JSON format. ClientToken A string of up to 64 ASCII characters that Amazon WorkSpaces uses to ensure idempotent creation. Type: String Pattern: ^.{1,64}$ Required: No LinkId The identiﬁer of the account link. Type: String Pattern: ^link-.{8,24}$ Required: Yes Response Syntax { "AccountLink": { "AccountLinkId": "string", DeleteAccountLinkInvitation API Version 2015-04-08 75 Amazon WorkSpaces Service API Reference "AccountLinkStatus": "string", "SourceAccountId": "string", "TargetAccountId": "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. AccountLink Information about the account link. Type: AccountLink 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 ConﬂictException The TargetAccountId is already linked or invited. HTTP Status Code: 400 InternalServerException Unexpected server error occured. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. Response Elements API Version 2015-04-08 76 Amazon WorkSpaces Service HTTP Status Code: 400 ValidationException API Reference You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 77 Amazon WorkSpaces Service API Reference DeleteClientBranding Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you delete your customized client branding, your login portal reverts to the default client branding. Request Syntax { "Platforms": [ "string" ], "ResourceId": "string" } Request Parameters The request accepts the following data in JSON format. Platforms The device type for which you want to delete client branding. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 6 items. Valid Values: DeviceTypeWindows \| DeviceTypeOsx \| DeviceTypeAndroid \| DeviceTypeIos \| DeviceTypeLinux \| DeviceTypeWeb Required: Yes ResourceId The directory identiﬁer of the WorkSpace for which you want to delete client branding. 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}$) DeleteClientBranding API Version 2015-04-08 78 Amazon WorkSpaces Service Required: Yes 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 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-speciﬁc AWS
workspaces-api-017	workspaces-api.pdf	17	DeleteClientBranding API Version 2015-04-08 78 Amazon WorkSpaces Service Required: Yes 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 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-speciﬁc 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 Response Elements API Version 2015-04-08 79 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 80 Amazon WorkSpaces Service API Reference DeleteConnectClientAddIn Deletes a client-add-in for Amazon Connect that is conﬁgured within a directory. Request Syntax { "AddInId": "string", "ResourceId": "string" } Request Parameters The request accepts the following data in JSON format. AddInId The identiﬁer of the client add-in to delete. 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 ResourceId The directory identiﬁer for which the client add-in is conﬁgured. 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 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. DeleteConnectClientAddIn API Version 2015-04-08 81 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 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-speciﬁc 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 82 Amazon WorkSpaces Service API Reference DeleteConnectionAlias Deletes the speciﬁed connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Important If you will no longer be using a fully qualiﬁed domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross- Region Redirection. Note To delete a connection alias that has been shared, the shared account must ﬁrst 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" } Request Parameters The request accepts the following data in JSON format. AliasId The identiﬁer of the connection alias to delete. Type: String Length Constraints: Minimum length of 13. Maximum length of 68. DeleteConnectionAlias API Version 2015-04-08 83 Amazon WorkSpaces Service API Reference Pattern: ^wsca-[0-9a-z]{8,63}$ 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 ResourceAssociatedException The resource is associated with a directory. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. Response Elements API Version 2015-04-08 84 Amazon WorkSpaces Service HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc 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
workspaces-api-018	workspaces-api.pdf	18	Status Code: 400 ResourceNotFoundException The resource could not be found. Response Elements API Version 2015-04-08 84 Amazon WorkSpaces Service HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc 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 85 Amazon WorkSpaces Service DeleteIpGroup Deletes the speciﬁed IP access control group. API Reference You cannot delete an IP access control group that is associated with a directory. Request Syntax { "GroupId": "string" } Request Parameters The request accepts the following data in JSON format. GroupId The identiﬁer of the IP access control group. Type: String Pattern: wsipg-[0-9a-z]{8,63}$ 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 DeleteIpGroup API Version 2015-04-08 86 Amazon WorkSpaces Service API Reference InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 ResourceAssociatedException The resource is associated with a directory. 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-speciﬁc 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 87 Amazon WorkSpaces Service DeleteTags Deletes the speciﬁed tags from the speciﬁed WorkSpaces resource. API Reference Request Syntax { "ResourceId": "string", "TagKeys": [ "string" ] } Request Parameters The request accepts the following data in JSON format. ResourceId The identiﬁer of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases. Type: String Length Constraints: Minimum length of 1. Required: Yes TagKeys The tag keys. Type: Array of strings Length Constraints: Minimum length of 1. 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. DeleteTags API Version 2015-04-08 88 Amazon WorkSpaces Service API Reference InvalidParameterValuesException One or more parameter values are not valid. 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-speciﬁc 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 89 Amazon WorkSpaces Service API Reference DeleteWorkspaceBundle Deletes the speciﬁed WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image. Request Syntax { "BundleId": "string" } Request Parameters The request accepts the following data in JSON format. BundleId The identiﬁer of the bundle. Type: String Pattern: ^wsb-[0-9a-z]{8,63}$ 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. DeleteWorkspaceBundle API Version 2015-04-08 90 API Reference Amazon WorkSpaces Service HTTP Status Code: 400 ResourceAssociatedException The resource is associated with a directory. 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-speciﬁc 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
workspaces-api-019	workspaces-api.pdf	19	Code: 400 ResourceAssociatedException The resource is associated with a directory. 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-speciﬁc 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 91 Amazon WorkSpaces Service API Reference DeleteWorkspaceImage Deletes the speciﬁed image from your account. To delete an image, you must ﬁrst delete any bundles that are associated with the image and unshare the image if it is shared with other accounts. Request Syntax { "ImageId": "string" } Request Parameters The request accepts the following data in JSON format. ImageId The identiﬁer of the image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ 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 DeleteWorkspaceImage API Version 2015-04-08 92 Amazon WorkSpaces Service InvalidResourceStateException The state of the resource is not valid for this operation. API Reference HTTP Status Code: 400 ResourceAssociatedException The resource is associated with a directory. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 93 Amazon WorkSpaces Service API Reference DeployWorkspaceApplications Deploys associated applications to the speciﬁed WorkSpace Request Syntax { "Force": boolean, "WorkspaceId": "string" } Request Parameters The request accepts the following data in JSON format. Force Indicates whether the force ﬂag is applied for the speciﬁed WorkSpace. When the force ﬂag is enabled, it allows previously failed deployments to be retried. Type: Boolean Required: No WorkspaceId The identiﬁer of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: Yes Response Syntax { "Deployment": { "Associations": [ { DeployWorkspaceApplications API Version 2015-04-08 94 Amazon WorkSpaces Service API Reference "AssociatedResourceId": "string", "AssociatedResourceType": "string", "Created": number, "LastUpdatedTime": number, "State": "string", "StateReason": { "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. Deployment The list of deployed associations and information about them. Type: WorkSpaceApplicationDeployment 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 IncompatibleApplicationsException The speciﬁed application is not compatible with the resource. HTTP Status Code: 400 Response Elements API Version 2015-04-08 95 Amazon WorkSpaces Service API Reference InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceInUseException The speciﬁed resource is currently in use. 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-speciﬁc 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 96 Amazon WorkSpaces Service API Reference DeregisterWorkspaceDirectory Deregisters the speciﬁed directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory. 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,
workspaces-api-020	workspaces-api.pdf	20	are registered to this directory, you must remove them before you can deregister the directory. 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 { "DirectoryId": "string" } Request Parameters The request accepts the following data in JSON format. DirectoryId The identiﬁer of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error. 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}$) DeregisterWorkspaceDirectory API Version 2015-04-08 97 Amazon WorkSpaces Service Required: Yes 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 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 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-speciﬁc AWS SDKs, see the following: Response Elements API Version 2015-04-08 98 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 99 Amazon WorkSpaces Service DescribeAccount API Reference Retrieves a list that describes the conﬁguration of Bring Your Own License (BYOL) for the speciﬁed account. Response Syntax { "DedicatedTenancyAccountType": "string", "DedicatedTenancyManagementCidrRange": "string", "DedicatedTenancySupport": "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. DedicatedTenancyAccountType The type of linked account. Type: String Valid Values: SOURCE_ACCOUNT \| TARGET_ACCOUNT DedicatedTenancyManagementCidrRange The IP address range, speciﬁed as an IPv4 CIDR block, used for the management network interface. The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace. 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$))$ DescribeAccount API Version 2015-04-08 100 Amazon WorkSpaces Service DedicatedTenancySupport The status of BYOL (whether BYOL is enabled or disabled). API Reference Type: String Valid Values: ENABLED \| DISABLED 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 See Also For more information about using this API in one of the language-speciﬁc 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 101 Amazon WorkSpaces Service API Reference DescribeAccountModiﬁcations Retrieves a list that describes modiﬁcations to the conﬁguration of Bring Your Own License (BYOL) for the speciﬁed account. Request Syntax { "NextToken": "string" } Request Parameters The request accepts the following data in JSON format. NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Response Syntax { "AccountModifications": [ { "DedicatedTenancyManagementCidrRange": "string", "DedicatedTenancySupport": "string", "ErrorCode": "string", "ErrorMessage": "string", "ModificationState": "string", "StartTime": number } ], "NextToken": "string" DescribeAccountModiﬁcations API Version 2015-04-08 102 API Reference Amazon WorkSpaces Service } 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. AccountModiﬁcations The list of modiﬁcations to the conﬁguration of BYOL. Type: Array of AccountModiﬁcation objects NextToken The token
workspaces-api-021	workspaces-api.pdf	21	this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Response Syntax { "AccountModifications": [ { "DedicatedTenancyManagementCidrRange": "string", "DedicatedTenancySupport": "string", "ErrorCode": "string", "ErrorMessage": "string", "ModificationState": "string", "StartTime": number } ], "NextToken": "string" DescribeAccountModiﬁcations API Version 2015-04-08 102 API Reference Amazon WorkSpaces Service } 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. AccountModiﬁcations The list of modiﬁcations to the conﬁguration of BYOL. Type: Array of AccountModiﬁcation objects NextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. 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 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Response Elements API Version 2015-04-08 103 API Reference Amazon WorkSpaces Service • 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 104 Amazon WorkSpaces Service API Reference DescribeApplicationAssociations Describes the associations between the application and the speciﬁed associated resources. Request Syntax { "ApplicationId": "string", "AssociatedResourceTypes": [ "string" ], "MaxResults": number, "NextToken": "string" } Request Parameters The request accepts the following data in JSON format. ApplicationId The identiﬁer of the speciﬁed application. Type: String Pattern: ^wsa-[0-9a-z]{8,63}$ Required: Yes AssociatedResourceTypes The resource type of the associated resources. Type: Array of strings Valid Values: WORKSPACE \| BUNDLE \| IMAGE Required: Yes MaxResults The maximum number of associations to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. DescribeApplicationAssociations API Version 2015-04-08 105 Amazon WorkSpaces Service Required: No NextToken API Reference If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Response Syntax { "Associations": [ { "ApplicationId": "string", "AssociatedResourceId": "string", "AssociatedResourceType": "string", "Created": number, "LastUpdatedTime": number, "State": "string", "StateReason": { "ErrorCode": "string", "ErrorMessage": "string" } } ], "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. Associations List of associations and information about them. Response Syntax API Version 2015-04-08 106 Amazon WorkSpaces Service API Reference Type: Array of ApplicationResourceAssociation objects NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. 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 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2015-04-08 107 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 108 Amazon WorkSpaces Service API Reference DescribeApplications Describes the speciﬁed applications by ﬁltering based on their compute types, license availability, operating systems, and owners. Request Syntax { "ApplicationIds": [ "string" ], "ComputeTypeNames": [ "string" ], "LicenseType": "string", "MaxResults": number, "NextToken": "string", "OperatingSystemNames": [ "string" ], "Owner": "string" } Request Parameters The request accepts the following data in JSON format. ApplicationIds The identiﬁers of one or more applications. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: ^wsa-[0-9a-z]{8,63}$ Required: No ComputeTypeNames The compute types supported by the applications. Type: Array of strings Valid Values: VALUE \| STANDARD \| PERFORMANCE \| POWER \| GRAPHICS \| POWERPRO \| GENERALPURPOSE_4XLARGE \| GENERALPURPOSE_8XLARGE \| GRAPHICSPRO \| GRAPHICS_G4DN \| GRAPHICSPRO_G4DN DescribeApplications API Version 2015-04-08 109 API Reference Amazon WorkSpaces Service Required: No LicenseType
workspaces-api-022	workspaces-api.pdf	22	"LicenseType": "string", "MaxResults": number, "NextToken": "string", "OperatingSystemNames": [ "string" ], "Owner": "string" } Request Parameters The request accepts the following data in JSON format. ApplicationIds The identiﬁers of one or more applications. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: ^wsa-[0-9a-z]{8,63}$ Required: No ComputeTypeNames The compute types supported by the applications. Type: Array of strings Valid Values: VALUE \| STANDARD \| PERFORMANCE \| POWER \| GRAPHICS \| POWERPRO \| GENERALPURPOSE_4XLARGE \| GENERALPURPOSE_8XLARGE \| GRAPHICSPRO \| GRAPHICS_G4DN \| GRAPHICSPRO_G4DN DescribeApplications API Version 2015-04-08 109 API Reference Amazon WorkSpaces Service Required: No LicenseType The license availability for the applications. Type: String Valid Values: LICENSED \| UNLICENSED Required: No MaxResults The maximum number of applications to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No OperatingSystemNames The operating systems supported by the applications. Type: Array of strings 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 Owner The owner of the applications. Request Parameters API Version 2015-04-08 110 API Reference Amazon WorkSpaces Service Type: String Pattern: ^\d{12}\|AMAZON$ Required: No Response Syntax { "Applications": [ { "ApplicationId": "string", "Created": number, "Description": "string", "LicenseType": "string", "Name": "string", "Owner": "string", "State": "string", "SupportedComputeTypeNames": [ "string" ], "SupportedOperatingSystemNames": [ "string" ] } ], "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. Applications List of information about the speciﬁed applications. Type: Array of WorkSpaceApplication objects NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Response Syntax API Version 2015-04-08 111 Amazon WorkSpaces Service API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. 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 See Also For more information about using this API in one of the language-speciﬁc 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 Errors API Version 2015-04-08 112 Amazon WorkSpaces Service • 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 113 Amazon WorkSpaces Service API Reference DescribeBundleAssociations Describes the associations between the applications and the speciﬁed bundle. Request Syntax { "AssociatedResourceTypes": [ "string" ], "BundleId": "string" } Request Parameters The request accepts the following data in JSON format. AssociatedResourceTypes The resource types of the associated resource. Type: Array of strings Valid Values: APPLICATION Required: Yes BundleId The identiﬁer of the bundle. Type: String Pattern: ^wsb-[0-9a-z]{8,63}$ Required: Yes Response Syntax { "Associations": [ { "AssociatedResourceId": "string", DescribeBundleAssociations API Version 2015-04-08 114 Amazon WorkSpaces Service API Reference "AssociatedResourceType": "string", "BundleId": "string", "Created": number, "LastUpdatedTime": number, "State": "string", "StateReason": { "ErrorCode": "string", "ErrorMessage": "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. Associations List of information about the speciﬁed associations. Type: Array of BundleResourceAssociation objects 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. Response Elements API Version 2015-04-08 115 Amazon WorkSpaces Service HTTP Status Code: 400 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-speciﬁc 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
workspaces-api-023	workspaces-api.pdf	23	Response Elements API Version 2015-04-08 115 Amazon WorkSpaces Service HTTP Status Code: 400 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-speciﬁc 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 116 Amazon WorkSpaces Service API Reference DescribeClientBranding Describes the speciﬁed client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. Note Only device types that have branding information conﬁgured will be shown in the response. Request Syntax { "ResourceId": "string" } Request Parameters The request accepts the following data in JSON format. ResourceId The directory identiﬁer of the WorkSpace for which you want to view client branding information. 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 Response Syntax { "DeviceTypeAndroid": { "ForgotPasswordLink": "string", DescribeClientBranding API Version 2015-04-08 117 Amazon WorkSpaces Service API Reference "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeIos": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo2xUrl": "string", "Logo3xUrl": "string", "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeLinux": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeOsx": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeWeb": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" Response Syntax API Version 2015-04-08 118 API Reference Amazon WorkSpaces Service }, "DeviceTypeWindows": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "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. DeviceTypeAndroid The branding information for Android devices. Type: DefaultClientBrandingAttributes object DeviceTypeIos The branding information for iOS devices. Type: IosClientBrandingAttributes object DeviceTypeLinux The branding information for Linux devices. Type: DefaultClientBrandingAttributes object DeviceTypeOsx The branding information for macOS devices. Type: DefaultClientBrandingAttributes object DeviceTypeWeb The branding information for Web access. Response Elements API Version 2015-04-08 119 Amazon WorkSpaces Service API Reference Type: DefaultClientBrandingAttributes object DeviceTypeWindows The branding information for Windows devices. Type: DefaultClientBrandingAttributes 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 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-speciﬁc 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 Errors API Version 2015-04-08 120 Amazon WorkSpaces Service • 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 121 Amazon WorkSpaces Service API Reference DescribeClientProperties Retrieves a list that describes one or more speciﬁed Amazon WorkSpaces clients. Request Syntax { "ResourceIds": [ "string" ] } Request Parameters The request accepts the following data in JSON format. ResourceIds The resource identiﬁer, in the form of directory IDs. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Length Constraints: Minimum length of 1. Required: Yes Response Syntax { "ClientPropertiesList": [ { "ClientProperties": { "LogUploadEnabled": "string", "ReconnectEnabled": "string" }, "ResourceId": "string" } ] } DescribeClientProperties API Version 2015-04-08 122 Amazon WorkSpaces Service Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ClientPropertiesList Information about the speciﬁed Amazon WorkSpaces clients. Type: Array of ClientPropertiesResult objects 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 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-speciﬁc
workspaces-api-024	workspaces-api.pdf	24	successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ClientPropertiesList Information about the speciﬁed Amazon WorkSpaces clients. Type: Array of ClientPropertiesResult objects 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 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-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Response Elements API Version 2015-04-08 123 Amazon WorkSpaces Service • 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 2015-04-08 124 Amazon WorkSpaces Service API Reference DescribeConnectClientAddIns Retrieves a list of Amazon Connect client add-ins that have been created. Request Syntax { "MaxResults": number, "NextToken": "string", "ResourceId": "string" } Request Parameters The request accepts the following data in JSON format. MaxResults The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ResourceId The directory identiﬁer for which the client add-in is conﬁgured. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. DescribeConnectClientAddIns API Version 2015-04-08 125 Amazon WorkSpaces Service API Reference Pattern: ^(d-[0-9a-f]{8,63}$)\|(wsd-[0-9a-z]{8,63}$) Required: Yes Response Syntax { "AddIns": [ { "AddInId": "string", "Name": "string", "ResourceId": "string", "URL": "string" } ], "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. AddIns Information about client add-ins. Type: Array of ConnectClientAddIn objects NextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2015-04-08 126 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 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-speciﬁc 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 127 Amazon WorkSpaces Service API Reference DescribeConnectionAliases Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Request Syntax { "AliasIds": [ "string" ], "Limit": number, "NextToken": "string", "ResourceId": "string" } Request Parameters The request accepts the following data in JSON format. AliasIds The identiﬁers of the connection aliases to describe. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: ^wsca-[0-9a-z]{8,63}$ Required: No Limit The maximum number of connection aliases to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No DescribeConnectionAliases API Version 2015-04-08 128 Amazon WorkSpaces Service NextToken API Reference If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ResourceId The identiﬁer of the directory associated with the connection alias. Type: String Length Constraints: Minimum length of 1. Required: No Response Syntax { "ConnectionAliases": [ { "AliasId": "string", "Associations": [ { "AssociatedAccountId": "string", "AssociationStatus": "string", "ConnectionIdentifier": "string", "ResourceId": "string" } ], "ConnectionString": "string", "OwnerAccountId": "string", "State": "string" } ], "NextToken": "string" } Response Syntax API Version 2015-04-08 129 Amazon WorkSpaces Service Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConnectionAliases Information
workspaces-api-025	workspaces-api.pdf	25	of 1. Maximum length of 2048. Required: No ResourceId The identiﬁer of the directory associated with the connection alias. Type: String Length Constraints: Minimum length of 1. Required: No Response Syntax { "ConnectionAliases": [ { "AliasId": "string", "Associations": [ { "AssociatedAccountId": "string", "AssociationStatus": "string", "ConnectionIdentifier": "string", "ResourceId": "string" } ], "ConnectionString": "string", "OwnerAccountId": "string", "State": "string" } ], "NextToken": "string" } Response Syntax API Version 2015-04-08 129 Amazon WorkSpaces Service Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConnectionAliases Information about the speciﬁed connection aliases. Type: Array of ConnectionAlias objects Array Members: Minimum number of 1 item. Maximum number of 25 items. NextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. 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 Response Elements API Version 2015-04-08 130 Amazon WorkSpaces Service See Also API Reference For more information about using this API in one of the language-speciﬁc 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 131 Amazon WorkSpaces Service API Reference DescribeConnectionAliasPermissions Describes the permissions that the owner of a connection alias has granted to another AWS account for the speciﬁed connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Request Syntax { "AliasId": "string", "MaxResults": number, "NextToken": "string" } Request Parameters The request accepts the following data in JSON format. AliasId The identiﬁer of the connection alias. Type: String Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: ^wsca-[0-9a-z]{8,63}$ Required: Yes MaxResults The maximum number of results to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. DescribeConnectionAliasPermissions API Version 2015-04-08 132 Amazon WorkSpaces Service Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Response Syntax { "AliasId": "string", "ConnectionAliasPermissions": [ { "AllowAssociation": boolean, "SharedAccountId": "string" } ], "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. AliasId The identiﬁer of the connection alias. Type: String Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: ^wsca-[0-9a-z]{8,63}$ ConnectionAliasPermissions The permissions associated with a connection alias. Type: Array of ConnectionAliasPermission objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Response Syntax API Version 2015-04-08 133 Amazon WorkSpaces Service NextToken API Reference The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. 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 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2015-04-08 134 API Reference Amazon WorkSpaces Service • 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 135 Amazon WorkSpaces Service API Reference DescribeImageAssociations Describes the associations between the applications and the speciﬁed image. Request Syntax { "AssociatedResourceTypes": [ "string" ], "ImageId": "string" } Request Parameters The request accepts the following data in JSON format. AssociatedResourceTypes The resource types of the associated resource. Type: Array of strings Valid Values: APPLICATION Required: Yes ImageId The identiﬁer of the image. Type:
workspaces-api-026	workspaces-api.pdf	26	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 135 Amazon WorkSpaces Service API Reference DescribeImageAssociations Describes the associations between the applications and the speciﬁed image. Request Syntax { "AssociatedResourceTypes": [ "string" ], "ImageId": "string" } Request Parameters The request accepts the following data in JSON format. AssociatedResourceTypes The resource types of the associated resource. Type: Array of strings Valid Values: APPLICATION Required: Yes ImageId The identiﬁer of the image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ Required: Yes Response Syntax { "Associations": [ { "AssociatedResourceId": "string", DescribeImageAssociations API Version 2015-04-08 136 Amazon WorkSpaces Service API Reference "AssociatedResourceType": "string", "Created": number, "ImageId": "string", "LastUpdatedTime": number, "State": "string", "StateReason": { "ErrorCode": "string", "ErrorMessage": "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. Associations List of information about the speciﬁed associations. Type: Array of ImageResourceAssociation objects 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. Response Elements API Version 2015-04-08 137 Amazon WorkSpaces Service HTTP Status Code: 400 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-speciﬁc 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 138 Amazon WorkSpaces Service DescribeIpGroups Describes one or more of your IP access control groups. API Reference Request Syntax { "GroupIds": [ "string" ], "MaxResults": number, "NextToken": "string" } Request Parameters The request accepts the following data in JSON format. GroupIds The identiﬁers of one or more IP access control groups. Type: Array of strings Pattern: wsipg-[0-9a-z]{8,63}$ Required: No MaxResults The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String DescribeIpGroups API Version 2015-04-08 139 Amazon WorkSpaces Service API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Response Syntax { "NextToken": "string", "Result": [ { "groupDesc": "string", "groupId": "string", "groupName": "string", "userRules": [ { "ipRule": "string", "ruleDesc": "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 The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Result Information about the IP access control groups. Type: Array of WorkspacesIpGroup objects Response Syntax API Version 2015-04-08 140 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 See Also For more information about using this API in one of the language-speciﬁc 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 141 Amazon WorkSpaces Service DescribeTags API Reference Describes the speciﬁed tags for the speciﬁed WorkSpaces resource. Request Syntax { "ResourceId": "string" } Request Parameters The request accepts the following data in JSON format. ResourceId The identiﬁer of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases. Type: String Length Constraints: Minimum length of 1. Required: Yes Response Syntax { "TagList": [ { "Key": "string", "Value": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. DescribeTags API Version 2015-04-08 142 Amazon WorkSpaces Service API
workspaces-api-027	workspaces-api.pdf	27	API Reference Describes the speciﬁed tags for the speciﬁed WorkSpaces resource. Request Syntax { "ResourceId": "string" } Request Parameters The request accepts the following data in JSON format. ResourceId The identiﬁer of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases. Type: String Length Constraints: Minimum length of 1. Required: Yes Response Syntax { "TagList": [ { "Key": "string", "Value": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. DescribeTags API Version 2015-04-08 142 Amazon WorkSpaces Service API Reference The following data is returned in JSON format by the service. TagList The tags. Type: Array of Tag objects Errors For information about the errors that are common to all actions, see Common Errors. 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-speciﬁc 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 143 Amazon WorkSpaces Service API Reference DescribeWorkspaceAssociations Describes the associations betweens applications and the speciﬁed WorkSpace. Request Syntax { "AssociatedResourceTypes": [ "string" ], "WorkspaceId": "string" } Request Parameters The request accepts the following data in JSON format. AssociatedResourceTypes The resource types of the associated resources. Type: Array of strings Valid Values: APPLICATION Required: Yes WorkspaceId The identiﬁer of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: Yes Response Syntax { "Associations": [ { "AssociatedResourceId": "string", DescribeWorkspaceAssociations API Version 2015-04-08 144 Amazon WorkSpaces Service API Reference "AssociatedResourceType": "string", "Created": number, "LastUpdatedTime": number, "State": "string", "StateReason": { "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. Associations List of information about the speciﬁed associations. Type: Array of WorkspaceResourceAssociation objects 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. Response Elements API Version 2015-04-08 145 Amazon WorkSpaces Service HTTP Status Code: 400 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-speciﬁc 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 146 Amazon WorkSpaces Service API Reference DescribeWorkspaceBundles Retrieves a list that describes the available WorkSpace bundles. You can ﬁlter the results using either bundle ID or owner, but not both. Request Syntax { "BundleIds": [ "string" ], "NextToken": "string", "Owner": "string" } Request Parameters The request accepts the following data in JSON format. BundleIds The identiﬁers of the bundles. You cannot combine this parameter with any other ﬁlter. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: ^wsb-[0-9a-z]{8,63}$ Required: No NextToken The token for the next set of results. (You received this token from a previous call.) Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Owner The owner of the bundles. You cannot combine this parameter with any other ﬁlter. DescribeWorkspaceBundles API Version 2015-04-08 147 Amazon WorkSpaces Service API Reference To describe the bundles provided by AWS, specify AMAZON. To describe the bundles that belong to your account, don't specify a value. Type: String Required: No Response Syntax { "Bundles": [ { "BundleId": "string", "BundleType": "string", "ComputeType": { "Name": "string" }, "CreationTime": number, "Description": "string", "ImageId": "string", "LastUpdatedTime": number, "Name": "string", "Owner": "string", "RootStorage": { "Capacity": "string" }, "State": "string", "UserStorage": { "Capacity": "string" } } ], "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. Response Syntax API Version 2015-04-08 148 Amazon WorkSpaces Service Bundles Information about the bundles. Type: Array of WorkspaceBundle objects NextToken API Reference The token to use to retrieve the next page of results. This value is null when there are
workspaces-api-028	workspaces-api.pdf	28	"ComputeType": { "Name": "string" }, "CreationTime": number, "Description": "string", "ImageId": "string", "LastUpdatedTime": number, "Name": "string", "Owner": "string", "RootStorage": { "Capacity": "string" }, "State": "string", "UserStorage": { "Capacity": "string" } } ], "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. Response Syntax API Version 2015-04-08 148 Amazon WorkSpaces Service Bundles Information about the bundles. Type: Array of WorkspaceBundle objects NextToken API Reference The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 Errors API Version 2015-04-08 149 Amazon WorkSpaces Service • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2015-04-08 150 Amazon WorkSpaces Service API Reference DescribeWorkspaceDirectories Describes the available directories that are registered with Amazon WorkSpaces. Request Syntax { "DirectoryIds": [ "string" ], "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "Limit": number, "NextToken": "string", "WorkspaceDirectoryNames": [ "string" ] } Request Parameters The request accepts the following data in JSON format. DirectoryIds The identiﬁers of the directories. If the value is null, all directories are retrieved. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. 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 Filters The ﬁlter condition for the WorkSpaces. Type: Array of DescribeWorkspaceDirectoriesFilter objects Array Members: Minimum number of 1 item. Maximum number of 25 items. DescribeWorkspaceDirectories API Version 2015-04-08 151 API Reference Amazon WorkSpaces Service Required: No Limit The maximum number of directories to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No WorkspaceDirectoryNames The names of the WorkSpace directories. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.\s-]{1,64}$ Required: No Response Syntax { "Directories": [ { "ActiveDirectoryConfig": { "DomainName": "string", "ServiceAccountSecretArn": "string" }, "Alias": "string", "CertificateBasedAuthProperties": { Response Syntax API Version 2015-04-08 152 Amazon WorkSpaces Service API Reference "CertificateAuthorityArn": "string", "Status": "string" }, "CustomerUserName": "string", "DirectoryId": "string", "DirectoryName": "string", "DirectoryType": "string", "DnsIpAddresses": [ "string" ], "EndpointEncryptionMode": "string", "ErrorMessage": "string", "IamRoleId": "string", "IDCConfig": { "ApplicationArn": "string", "InstanceArn": "string" }, "ipGroupIds": [ "string" ], "MicrosoftEntraConfig": { "ApplicationConfigSecretArn": "string", "TenantId": "string" }, "RegistrationCode": "string", "SamlProperties": { "RelayStateParameterName": "string", "Status": "string", "UserAccessUrl": "string" }, "SelfservicePermissions": { "ChangeComputeType": "string", "IncreaseVolumeSize": "string", "RebuildWorkspace": "string", "RestartWorkspace": "string", "SwitchRunningMode": "string" }, "State": "string", "StreamingProperties": { "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "StorageConnectors": [ { "ConnectorType": "string", "Status": "string" } Response Syntax API Version 2015-04-08 153 Amazon WorkSpaces Service API Reference ], "StreamingExperiencePreferredProtocol": "string", "UserSettings": [ { "Action": "string", "MaximumLength": number, "Permission": "string" } ] }, "SubnetIds": [ "string" ], "Tenancy": "string", "UserIdentityType": "string", "WorkspaceAccessProperties": { "DeviceTypeAndroid": "string", "DeviceTypeChromeOs": "string", "DeviceTypeIos": "string", "DeviceTypeLinux": "string", "DeviceTypeOsx": "string", "DeviceTypeWeb": "string", "DeviceTypeWindows": "string", "DeviceTypeWorkSpacesThinClient": "string", "DeviceTypeZeroClient": "string" }, "WorkspaceCreationProperties": { "CustomSecurityGroupId": "string", "DefaultOu": "string", "EnableInternetAccess": boolean, "EnableMaintenanceMode": boolean, "InstanceIamRoleArn": "string", "UserEnabledAsLocalAdministrator": boolean }, "WorkspaceDirectoryDescription": "string", "WorkspaceDirectoryName": "string", "WorkspaceSecurityGroupId": "string", "WorkspaceType": "string" } ], "NextToken": "string" } Response Syntax API Version 2015-04-08 154 Amazon WorkSpaces Service Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Directories Information about the directories. Type: Array of WorkspaceDirectory objects NextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line
workspaces-api-029	workspaces-api.pdf	29	by the service. Directories Information about the directories. Type: Array of WorkspaceDirectory objects NextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Response Elements API Version 2015-04-08 155 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 156 Amazon WorkSpaces Service API Reference DescribeWorkspaceImagePermissions Describes the permissions that the owner of an image has granted to other AWS accounts for an image. Request Syntax { "ImageId": "string", "MaxResults": number, "NextToken": "string" } Request Parameters The request accepts the following data in JSON format. ImageId The identiﬁer of the image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ Required: Yes MaxResults The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String DescribeWorkspaceImagePermissions API Version 2015-04-08 157 Amazon WorkSpaces Service API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Response Syntax { "ImageId": "string", "ImagePermissions": [ { "SharedAccountId": "string" } ], "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. ImageId The identiﬁer of the image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ ImagePermissions The identiﬁers of the AWS accounts that the image has been shared with. Type: Array of ImagePermission objects NextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Response Syntax API Version 2015-04-08 158 Amazon WorkSpaces Service API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. 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 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-speciﬁc 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 159 Amazon WorkSpaces Service API Reference See Also API Version 2015-04-08 160 Amazon WorkSpaces Service API Reference DescribeWorkspaceImages Retrieves a list that describes one or more speciﬁed images, if the image identiﬁers are provided. Otherwise, all images in the account are described. Request Syntax { "ImageIds": [ "string" ], "ImageType": "string", "MaxResults": number, "NextToken": "string" } Request Parameters The request accepts the following data in JSON format. ImageIds The identiﬁer of the image. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: wsi-[0-9a-z]{9,63}$ Required: No ImageType The type (owned or shared) of the image. Type: String Valid Values: OWNED \| SHARED Required: No MaxResults The maximum number of items to return. DescribeWorkspaceImages API Version 2015-04-08 161 Amazon WorkSpaces Service Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. API Reference Required: No NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Response Syntax { "Images": [ { "Created": number, "Description": "string", "ErrorCode": "string", "ErrorDetails": [ { "ErrorCode": "string", "ErrorMessage": "string" } ], "ErrorMessage": "string", "ImageId": "string", "Name": "string", "OperatingSystem": { "Type": "string" }, "OwnerAccountId": "string", "RequiredTenancy": "string", "State": "string", "Updates": { "Description": "string", "UpdateAvailable": boolean Response Syntax API Version 2015-04-08 162 Amazon WorkSpaces Service } } ], "NextToken": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following
workspaces-api-030	workspaces-api.pdf	30	token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Response Syntax { "Images": [ { "Created": number, "Description": "string", "ErrorCode": "string", "ErrorDetails": [ { "ErrorCode": "string", "ErrorMessage": "string" } ], "ErrorMessage": "string", "ImageId": "string", "Name": "string", "OperatingSystem": { "Type": "string" }, "OwnerAccountId": "string", "RequiredTenancy": "string", "State": "string", "Updates": { "Description": "string", "UpdateAvailable": boolean Response Syntax API Version 2015-04-08 162 Amazon WorkSpaces Service } } ], "NextToken": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Images Information about the images. Type: Array of WorkspaceImage objects NextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. 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 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Response Elements API Version 2015-04-08 163 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 164 Amazon WorkSpaces Service API Reference DescribeWorkspaces Describes the speciﬁed WorkSpaces. You can ﬁlter the results by using the bundle identiﬁer, directory identiﬁer, or owner, but you can specify only one ﬁlter at a time. Request Syntax { "BundleId": "string", "DirectoryId": "string", "Limit": number, "NextToken": "string", "UserName": "string", "WorkspaceIds": [ "string" ], "WorkspaceName": "string" } Request Parameters The request accepts the following data in JSON format. BundleId The identiﬁer of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other ﬁlter. Type: String Pattern: ^wsb-[0-9a-z]{8,63}$ Required: No DirectoryId The identiﬁer of the directory. In addition, you can optionally specify a speciﬁc directory user (see UserName). You cannot combine this parameter with any other ﬁlter. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. DescribeWorkspaces API Version 2015-04-08 165 Amazon WorkSpaces Service API Reference Pattern: ^(d-[0-9a-f]{8,63}$)\|(wsd-[0-9a-z]{8,63}$) Required: No Limit The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No UserName The name of the directory user. You must specify this parameter with DirectoryId. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Required: No WorkspaceIds The identiﬁers of the WorkSpaces. You cannot combine this parameter with any other ﬁlter. Because the CreateWorkspaces operation is asynchronous, the identiﬁer it returns is not immediately available. If you immediately call DescribeWorkspaces with this identiﬁer, no information is returned. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Request Parameters API Version 2015-04-08 166 Amazon WorkSpaces Service API Reference 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 Response Syntax { "NextToken": "string", "Workspaces": [ { "BundleId": "string", "ComputerName": "string", "DataReplicationSettings": { "DataReplication": "string", "RecoverySnapshotTime": number }, "DirectoryId": "string", "ErrorCode": "string", "ErrorMessage": "string", "IpAddress": "string", "ModificationStates": [ { "Resource": "string", "State": "string" } ], "RelatedWorkspaces": [ { "Region": "string", "State": "string", "Type": "string", "WorkspaceId": "string" } Response Syntax API Version 2015-04-08 167 Amazon WorkSpaces Service API Reference ], "RootVolumeEncryptionEnabled": boolean, "StandbyWorkspacesProperties": [ { "DataReplication": "string", "RecoverySnapshotTime": number, "StandbyWorkspaceId": "string" } ], "State": "string", "SubnetId": "string", "UserName": "string", "UserVolumeEncryptionEnabled": boolean, "VolumeEncryptionKey": "string", "WorkspaceId": "string", "WorkspaceName": "string", "WorkspaceProperties": { "ComputeTypeName": "string", "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "OperatingSystemName": "string", "Protocols": [ "string" ], "RootVolumeSizeGib": number, "RunningMode": "string", "RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": 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. NextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Response Elements API Version 2015-04-08 168 Amazon WorkSpaces Service Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Workspaces Information about the WorkSpaces. Because CreateWorkspaces is an asynchronous operation, some of the returned
workspaces-api-031	workspaces-api.pdf	31	"RootVolumeSizeGib": number, "RunningMode": "string", "RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": 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. NextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Response Elements API Version 2015-04-08 168 Amazon WorkSpaces Service Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Workspaces Information about the WorkSpaces. Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete. Type: Array of Workspace objects Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 ResourceUnavailableException The speciﬁed resource is not available. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 Errors API Version 2015-04-08 169 Amazon WorkSpaces Service • 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 170 Amazon WorkSpaces Service API Reference DescribeWorkspacesConnectionStatus Describes the connection status of the speciﬁed WorkSpaces. Request Syntax { "NextToken": "string", "WorkspaceIds": [ "string" ] } Request Parameters The request accepts the following data in JSON format. NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No WorkspaceIds The identiﬁers of the WorkSpaces. You can specify up to 25 WorkSpaces. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: ^ws-[0-9a-z]{8,63}$ Required: No Response Syntax { DescribeWorkspacesConnectionStatus API Version 2015-04-08 171 Amazon WorkSpaces Service API Reference "NextToken": "string", "WorkspacesConnectionStatus": [ { "ConnectionState": "string", "ConnectionStateCheckTimestamp": number, "LastKnownUserConnectionTimestamp": number, "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. NextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. WorkspacesConnectionStatus Information about the connection status of the WorkSpace. Type: Array of WorkspaceConnectionStatus objects Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 Response Elements API Version 2015-04-08 172 Amazon WorkSpaces Service See Also API Reference For more information about using this API in one of the language-speciﬁc 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 173 Amazon WorkSpaces Service API Reference DescribeWorkspaceSnapshots Describes the snapshots for the speciﬁed WorkSpace. Request Syntax { "WorkspaceId": "string" } Request Parameters The request accepts the following data in JSON format. WorkspaceId The identiﬁer of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: Yes Response Syntax { "RebuildSnapshots": [ { "SnapshotTime": number } ], "RestoreSnapshots": [ { "SnapshotTime": number } ] } DescribeWorkspaceSnapshots API Version 2015-04-08 174 Amazon WorkSpaces Service Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. RebuildSnapshots Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume. Type: Array of Snapshot objects RestoreSnapshots Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume. Type: Array of Snapshot objects 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 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 Response Elements API Version 2015-04-08 175 Amazon WorkSpaces Service See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: •
workspaces-api-032	workspaces-api.pdf	32	These snapshots include both the root volume and the user volume. Type: Array of Snapshot objects 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 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 Response Elements API Version 2015-04-08 175 Amazon WorkSpaces Service See Also API Reference For more information about using this API in one of the language-speciﬁc 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 176 Amazon WorkSpaces Service API Reference DescribeWorkspacesPools Describes the speciﬁed WorkSpaces Pools. Request Syntax { "Filters": [ { "Name": "string", "Operator": "string", "Values": [ "string" ] } ], "Limit": number, "NextToken": "string", "PoolIds": [ "string" ] } Request Parameters The request accepts the following data in JSON format. Filters The ﬁlter conditions for the WorkSpaces Pool to return. Type: Array of DescribeWorkspacesPoolsFilter objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: No Limit The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No DescribeWorkspacesPools API Version 2015-04-08 177 Amazon WorkSpaces Service NextToken API Reference If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No PoolIds The identiﬁer of the WorkSpaces Pools. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: ^wspool-[0-9a-z]{9}$ Required: No Response Syntax { "NextToken": "string", "WorkspacesPools": [ { "ApplicationSettings": { "S3BucketName": "string", "SettingsGroup": "string", "Status": "string" }, "BundleId": "string", "CapacityStatus": { "ActiveUserSessions": number, "ActualUserSessions": number, "AvailableUserSessions": number, "DesiredUserSessions": number }, "CreatedAt": number, Response Syntax API Version 2015-04-08 178 Amazon WorkSpaces Service API Reference "Description": "string", "DirectoryId": "string", "Errors": [ { "ErrorCode": "string", "ErrorMessage": "string" } ], "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. NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. WorkspacesPools Information about the WorkSpaces Pools. Type: Array of WorkspacesPool objects Response Elements API Version 2015-04-08 179 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 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-speciﬁc 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 180 Amazon WorkSpaces Service API Reference DescribeWorkspacesPoolSessions Retrieves a list that describes the streaming sessions for a speciﬁed pool. Request Syntax { "Limit": number, "NextToken": "string", "PoolId": "string", "UserId": "string" } Request Parameters The request accepts the following data in JSON format. Limit The maximum size of each page of results. The default value is 20 and the maximum value is 50. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No PoolId The identiﬁer of the pool. DescribeWorkspacesPoolSessions API Version 2015-04-08 181 API Reference Amazon WorkSpaces Service Type: String Pattern: ^wspool-[0-9a-z]{9}$ Required: Yes UserId The identiﬁer of the user. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Required: No Response Syntax { "NextToken": "string", "Sessions": [ { "AuthenticationType": "string", "ConnectionState": "string", "ExpirationTime": number, "InstanceId": "string", "NetworkAccessConfiguration": { "EniId": "string", "EniPrivateIpAddress":
workspaces-api-033	workspaces-api.pdf	33	NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No PoolId The identiﬁer of the pool. DescribeWorkspacesPoolSessions API Version 2015-04-08 181 API Reference Amazon WorkSpaces Service Type: String Pattern: ^wspool-[0-9a-z]{9}$ Required: Yes UserId The identiﬁer of the user. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Required: No Response Syntax { "NextToken": "string", "Sessions": [ { "AuthenticationType": "string", "ConnectionState": "string", "ExpirationTime": number, "InstanceId": "string", "NetworkAccessConfiguration": { "EniId": "string", "EniPrivateIpAddress": "string" }, "PoolId": "string", "SessionId": "string", "StartTime": number, "UserId": "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. Response Syntax API Version 2015-04-08 182 Amazon WorkSpaces Service NextToken API Reference If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Sessions Describes the pool sessions. Type: Array of WorkspacesPoolSession objects 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 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-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2015-04-08 183 API Reference Amazon WorkSpaces Service • 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 184 Amazon WorkSpaces Service API Reference DisassociateConnectionAlias Disassociates a connection alias from a directory. Disassociating a connection alias disables cross- Region redirection between two directories in diﬀerent Regions. 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. Request Syntax { "AliasId": "string" } Request Parameters The request accepts the following data in JSON format. AliasId The identiﬁer of the connection alias to disassociate. Type: String Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: ^wsca-[0-9a-z]{8,63}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. DisassociateConnectionAlias API Version 2015-04-08 185 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 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-speciﬁc 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 186 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 187 Amazon WorkSpaces Service API Reference DisassociateIpGroups Disassociates the speciﬁed IP access control group from the speciﬁed directory. Request Syntax { "DirectoryId": "string", "GroupIds": [ "string" ] } Request Parameters The request accepts the following data in JSON format. DirectoryId The identiﬁer 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: Yes GroupIds The identiﬁers of one or more IP access control groups. Type: Array of strings Pattern: wsipg-[0-9a-z]{8,63}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. DisassociateIpGroups API Version 2015-04-08 188 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
workspaces-api-034	workspaces-api.pdf	34	one or more IP access control groups. Type: Array of strings Pattern: wsipg-[0-9a-z]{8,63}$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. DisassociateIpGroups API Version 2015-04-08 188 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 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-speciﬁc 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 189 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 190 Amazon WorkSpaces Service API Reference DisassociateWorkspaceApplication Disassociates the speciﬁed application from a WorkSpace. Request Syntax { "ApplicationId": "string", "WorkspaceId": "string" } Request Parameters The request accepts the following data in JSON format. ApplicationId The identiﬁer of the application. Type: String Pattern: ^wsa-[0-9a-z]{8,63}$ Required: Yes WorkspaceId The identiﬁer of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: Yes Response Syntax { "Association": { "AssociatedResourceId": "string", "AssociatedResourceType": "string", DisassociateWorkspaceApplication API Version 2015-04-08 191 Amazon WorkSpaces Service API Reference "Created": number, "LastUpdatedTime": number, "State": "string", "StateReason": { "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. Association Information about the targeted association. Type: WorkspaceResourceAssociation 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 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 Response Elements API Version 2015-04-08 192 API Reference Amazon WorkSpaces Service ResourceInUseException The speciﬁed resource is currently in use. 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-speciﬁc 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 193 API Reference Amazon WorkSpaces Service GetAccountLink Retrieves account link information. Request Syntax { "LinkedAccountId": "string", "LinkId": "string" } Request Parameters The request accepts the following data in JSON format. LinkedAccountId The identiﬁer of the account link Type: String Pattern: ^\d{12}$ Required: No LinkId The identiﬁer of the account to link. Type: String Pattern: ^link-.{8,24}$ Required: No Response Syntax { "AccountLink": { "AccountLinkId": "string", "AccountLinkStatus": "string", GetAccountLink API Version 2015-04-08 194 Amazon WorkSpaces Service API Reference "SourceAccountId": "string", "TargetAccountId": "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. AccountLink The account link of the account link to retrieve. Type: AccountLink 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 InternalServerException Unexpected server error occured. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 ValidationException You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId. Response Elements API Version 2015-04-08 195 Amazon WorkSpaces Service HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc 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 196 Amazon WorkSpaces Service API Reference ImportClientBranding Imports client branding. Client branding allows
workspaces-api-035	workspaces-api.pdf	35	WorkSpaces Service HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc 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 196 Amazon WorkSpaces Service API Reference ImportClientBranding Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you import client branding, the default branding experience for the speciﬁed platform type is replaced with the imported experience Note • You must specify at least one platform type when importing client branding. • You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for diﬀerent platform types using separate requests. • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both. • Imported data can take up to a minute to appear in the WorkSpaces client. Request Syntax { "DeviceTypeAndroid": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo": blob, "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeIos": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo": blob, "Logo2x": blob, "Logo3x": blob, ImportClientBranding API Version 2015-04-08 197 Amazon WorkSpaces Service API Reference "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeLinux": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo": blob, "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeOsx": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo": blob, "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeWeb": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo": blob, "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeWindows": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo": blob, "SupportEmail": "string", "SupportLink": "string" }, "ResourceId": "string" } Request Syntax API Version 2015-04-08 198 API Reference Amazon WorkSpaces Service Request Parameters The request accepts the following data in JSON format. DeviceTypeAndroid The branding information to import for Android devices. Type: DefaultImportClientBrandingAttributes object Required: No DeviceTypeIos The branding information to import for iOS devices. Type: IosImportClientBrandingAttributes object Required: No DeviceTypeLinux The branding information to import for Linux devices. Type: DefaultImportClientBrandingAttributes object Required: No DeviceTypeOsx The branding information to import for macOS devices. Type: DefaultImportClientBrandingAttributes object Required: No DeviceTypeWeb The branding information to import for web access. Type: DefaultImportClientBrandingAttributes object Required: No DeviceTypeWindows The branding information to import for Windows devices. Request Parameters API Version 2015-04-08 199 Amazon WorkSpaces Service API Reference Type: DefaultImportClientBrandingAttributes object Required: No ResourceId The directory identiﬁer of the WorkSpace for which you want to import client branding. 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 Response Syntax { "DeviceTypeAndroid": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeIos": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo2xUrl": "string", "Logo3xUrl": "string", "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeLinux": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" Response Syntax API Version 2015-04-08 200 Amazon WorkSpaces Service API Reference }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeOsx": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeWeb": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeWindows": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "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. DeviceTypeAndroid The branding information conﬁgured for Android devices. Response Elements API Version 2015-04-08 201 Amazon WorkSpaces Service API Reference Type: DefaultClientBrandingAttributes object DeviceTypeIos The branding information conﬁgured for iOS devices. Type: IosClientBrandingAttributes object DeviceTypeLinux The branding information conﬁgured for Linux devices. Type: DefaultClientBrandingAttributes object DeviceTypeOsx The branding information conﬁgured for macOS devices. Type: DefaultClientBrandingAttributes object DeviceTypeWeb The branding information conﬁgured for web access. Type: DefaultClientBrandingAttributes object DeviceTypeWindows The branding information conﬁgured for Windows devices. Type: DefaultClientBrandingAttributes 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 Errors API Version 2015-04-08 202 Amazon WorkSpaces Service API Reference ResourceLimitExceededException Your resource limits have been exceeded. HTTP Status Code: 400 ResourceNotFoundException
workspaces-api-036	workspaces-api.pdf	36	Type: DefaultClientBrandingAttributes object DeviceTypeOsx The branding information conﬁgured for macOS devices. Type: DefaultClientBrandingAttributes object DeviceTypeWeb The branding information conﬁgured for web access. Type: DefaultClientBrandingAttributes object DeviceTypeWindows The branding information conﬁgured for Windows devices. Type: DefaultClientBrandingAttributes 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 Errors API Version 2015-04-08 202 Amazon WorkSpaces Service API Reference 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-speciﬁc 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 203 Amazon WorkSpaces Service API Reference ImportWorkspaceImage Imports the speciﬁed Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses. Request Syntax { "Applications": [ "string" ], "Ec2ImageId": "string", "ImageDescription": "string", "ImageName": "string", "IngestionProcess": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters The request accepts the following data in JSON format. Applications If speciﬁed, the version of Microsoft Oﬃce to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Oﬃce for BYOL images, see Bring Your Own Windows Desktop Licenses. Note • Although this parameter is an array, only one item is allowed at this time. • During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support only Microsoft_Office_2019. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not support Oﬃce installation. ImportWorkspaceImage API Version 2015-04-08 204 Amazon WorkSpaces Service Type: Array of strings API Reference Array Members: Minimum number of 1 item. Maximum number of 5 items. Valid Values: Microsoft_Office_2016 \| Microsoft_Office_2019 Required: No Ec2ImageId The identiﬁer of the EC2 image. Type: String Pattern: ^ami\-([a-f0-9]{8}\|[a-f0-9]{17})$ Required: Yes ImageDescription The description of the WorkSpace image. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9_./() -]+$ Required: Yes ImageName The name of the WorkSpace image. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[a-zA-Z0-9_./()\\-]+$ Required: Yes IngestionProcess The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WSP, or bring your own protocol Request Parameters API Version 2015-04-08 205 Amazon WorkSpaces Service API Reference (BYOP). To use DCV, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP. For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol. Note The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core. Type: String Valid Values: BYOL_REGULAR \| BYOL_GRAPHICS \| BYOL_GRAPHICSPRO \| BYOL_GRAPHICS_G4DN \| BYOL_REGULAR_WSP \| BYOL_GRAPHICS_G4DN_WSP \| BYOL_REGULAR_BYOP \| BYOL_GRAPHICS_G4DN_BYOP Required: Yes Tags The tags. Each WorkSpaces resource can have a maximum of 50 tags. Type: Array of Tag objects Required: No Response Syntax { "ImageId": "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. Response Syntax API Version 2015-04-08 206 API Reference Amazon WorkSpaces Service ImageId The identiﬁer of the WorkSpace image. Type: String Pattern: wsi-[0-9a-z]{9,63}$ 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 ResourceAlreadyExistsException The speciﬁed resource already exists. HTTP Status Code: 400 ResourceLimitExceededException Your resource limits have been exceeded. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. Errors API Version 2015-04-08 207 Amazon WorkSpaces Service HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS
workspaces-api-037	workspaces-api.pdf	37	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 ResourceAlreadyExistsException The speciﬁed resource already exists. HTTP Status Code: 400 ResourceLimitExceededException Your resource limits have been exceeded. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. Errors API Version 2015-04-08 207 Amazon WorkSpaces Service HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc 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 208 API Reference Amazon WorkSpaces Service ListAccountLinks Lists all account links. Request Syntax { "LinkStatusFilter": [ "string" ], "MaxResults": number, "NextToken": "string" } Request Parameters The request accepts the following data in JSON format. LinkStatusFilter Filters the account based on their link status. Type: Array of strings Valid Values: LINKED \| LINKING_FAILED \| LINK_NOT_FOUND \| PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT \| REJECTED Required: No MaxResults The maximum number of accounts to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No NextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String ListAccountLinks API Version 2015-04-08 209 Amazon WorkSpaces Service API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Response Syntax { "AccountLinks": [ { "AccountLinkId": "string", "AccountLinkStatus": "string", "SourceAccountId": "string", "TargetAccountId": "string" } ], "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. AccountLinks Information about the account links. Type: Array of AccountLink objects NextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2015-04-08 210 API Reference Amazon WorkSpaces Service AccessDeniedException The user is not authorized to access a resource. HTTP Status Code: 400 InternalServerException Unexpected server error occured. HTTP Status Code: 400 ValidationException You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 211 Amazon WorkSpaces Service API Reference ListAvailableManagementCidrRanges Retrieves a list of IP address ranges, speciﬁed as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL). This operation can be run only by AWS accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException error. The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace. Request Syntax { "ManagementCidrRangeConstraint": "string", "MaxResults": number, "NextToken": "string" } Request Parameters The request accepts the following data in JSON format. ManagementCidrRangeConstraint The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). Type: String Pattern: ^(([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])\.){3}([0-9]\| [1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])(\/(3[0-2]\|[1-2][0-9]\|[0-9]))$ Required: Yes MaxResults The maximum number of items to return. Type: Integer ListAvailableManagementCidrRanges API Version 2015-04-08 212 Amazon WorkSpaces Service API Reference Valid Range: Minimum value of 1. Maximum value of 5. Required: No NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Response Syntax { "ManagementCidrRanges": [ "string" ], "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. ManagementCidrRanges The list of available IP address ranges, speciﬁed as IPv4 CIDR blocks.
workspaces-api-038	workspaces-api.pdf	38	API Reference Valid Range: Minimum value of 1. Maximum value of 5. Required: No NextToken If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Response Syntax { "ManagementCidrRanges": [ "string" ], "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. ManagementCidrRanges The list of available IP address ranges, speciﬁed as IPv4 CIDR blocks. Type: Array of strings 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$))$ NextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Response Syntax API Version 2015-04-08 213 Amazon WorkSpaces Service API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. 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 See Also For more information about using this API in one of the language-speciﬁc 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 214 Amazon WorkSpaces Service MigrateWorkspace API Reference Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume. The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user proﬁle folder is renamed to D:\Users \%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain ﬁles in the old user proﬁle are moved to the new user proﬁle. For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace. Request Syntax { "BundleId": "string", "SourceWorkspaceId": "string" } Request Parameters The request accepts the following data in JSON format. BundleId The identiﬁer of the target bundle type to migrate the WorkSpace to. Type: String Pattern: ^wsb-[0-9a-z]{8,63}$ Required: Yes SourceWorkspaceId The identiﬁer of the WorkSpace to migrate from. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ MigrateWorkspace API Version 2015-04-08 215 API Reference Amazon WorkSpaces Service Required: Yes Response Syntax { "SourceWorkspaceId": "string", "TargetWorkspaceId": "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. SourceWorkspaceId The original identiﬁer of the WorkSpace that is being migrated. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ TargetWorkspaceId The new identiﬁer of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ 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. Response Syntax API Version 2015-04-08 216 Amazon WorkSpaces Service HTTP Status Code: 400 InvalidParameterValuesException One or more parameter values are not valid. HTTP Status Code: 400 OperationInProgressException API Reference The properties of this WorkSpace are currently being modiﬁed. 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 ResourceUnavailableException The speciﬁed resource is not available. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 See Also API Version 2015-04-08 217 Amazon WorkSpaces Service • 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 218 Amazon WorkSpaces Service ModifyAccount API Reference Modiﬁes the conﬁguration of Bring Your Own License (BYOL) for the speciﬁed account. Request Syntax { "DedicatedTenancyManagementCidrRange": "string", "DedicatedTenancySupport": "string" } Request Parameters The request accepts the following data in JSON format. DedicatedTenancyManagementCidrRange The IP address range, speciﬁed as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation
workspaces-api-039	workspaces-api.pdf	39	Service • 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 218 Amazon WorkSpaces Service ModifyAccount API Reference Modiﬁes the conﬁguration of Bring Your Own License (BYOL) for the speciﬁed account. Request Syntax { "DedicatedTenancyManagementCidrRange": "string", "DedicatedTenancySupport": "string" } Request Parameters The request accepts the following data in JSON format. DedicatedTenancyManagementCidrRange The IP address range, speciﬁed as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be speciﬁed as available by the ListAvailableManagementCidrRanges operation. 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. Type: String Valid Values: ENABLED Required: No ModifyAccount API Version 2015-04-08 219 Amazon WorkSpaces Service 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 InvalidResourceStateException The state of the resource is not valid for this operation. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 ResourceUnavailableException The speciﬁed resource is not available. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Response Elements API Version 2015-04-08 220 API Reference Amazon WorkSpaces Service • 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 221 Amazon WorkSpaces Service API Reference ModifyCertiﬁcateBasedAuthProperties Modiﬁes the properties of the certiﬁcate-based authentication you want to use with your WorkSpaces. Request Syntax { "CertificateBasedAuthProperties": { "CertificateAuthorityArn": "string", "Status": "string" }, "PropertiesToDelete": [ "string" ], "ResourceId": "string" } Request Parameters The request accepts the following data in JSON format. CertiﬁcateBasedAuthProperties The properties of the certiﬁcate-based authentication. Type: CertiﬁcateBasedAuthProperties object Required: No PropertiesToDelete The properties of the certiﬁcate-based authentication you want to delete. Type: Array of strings Valid Values: CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN Required: No ResourceId The resource identiﬁers, in the form of directory IDs. Type: String ModifyCertiﬁcateBasedAuthProperties API Version 2015-04-08 222 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: 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 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-speciﬁc AWS SDKs, see the following: Response Elements API Version 2015-04-08 223 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 224 Amazon WorkSpaces Service API Reference ModifyClientProperties Modiﬁes the properties of the speciﬁed Amazon WorkSpaces clients. Request Syntax { "ClientProperties": { "LogUploadEnabled": "string", "ReconnectEnabled": "string" }, "ResourceId": "string" } Request Parameters The request accepts the following data in JSON format. ClientProperties Information about the Amazon WorkSpaces client. Type: ClientProperties object Required: Yes ResourceId The resource identiﬁers, in the form of directory IDs. Type: String Length Constraints: Minimum length of 1. 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. ModifyClientProperties API Version 2015-04-08 225 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
workspaces-api-040	workspaces-api.pdf	40	directory IDs. Type: String Length Constraints: Minimum length of 1. 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. ModifyClientProperties API Version 2015-04-08 225 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 See Also For more information about using this API in one of the language-speciﬁc 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 226 Amazon WorkSpaces Service API Reference ModifyEndpointEncryptionMode Modiﬁes the endpoint encryption mode that allows you to conﬁgure the speciﬁed directory between Standard TLS and FIPS 140-2 validated mode. Request Syntax { "DirectoryId": "string", "EndpointEncryptionMode": "string" } Request Parameters The request accepts the following data in JSON format. DirectoryId The identiﬁer 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: Yes EndpointEncryptionMode The encryption mode used for endpoint connections when streaming to WorkSpaces Personal or WorkSpace Pools. Type: String Valid Values: STANDARD_TLS \| FIPS_VALIDATED Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ModifyEndpointEncryptionMode API Version 2015-04-08 227 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 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-speciﬁc 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 228 Amazon WorkSpaces Service API Reference ModifySamlProperties Modiﬁes multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for conﬁguring federation with an SAML 2.0 identity provider. Request Syntax { "PropertiesToDelete": [ "string" ], "ResourceId": "string", "SamlProperties": { "RelayStateParameterName": "string", "Status": "string", "UserAccessUrl": "string" } } Request Parameters The request accepts the following data in JSON format. PropertiesToDelete The SAML properties to delete as part of your request. Specify one of the following options: • SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL. • SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name. Type: Array of strings Valid Values: SAML_PROPERTIES_USER_ACCESS_URL \| SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME Required: No ResourceId The directory identiﬁer for which you want to conﬁgure SAML properties. ModifySamlProperties API Version 2015-04-08 229 Amazon WorkSpaces Service Type: String 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: Yes SamlProperties The properties for conﬁguring SAML 2.0 authentication. Type: SamlProperties object 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 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. Response Elements API Version 2015-04-08 230 Amazon WorkSpaces Service HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc 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 231 Amazon WorkSpaces Service API Reference ModifySelfservicePermissions Modiﬁes the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for
workspaces-api-041	workspaces-api.pdf	41	about using this API in one of the language-speciﬁc 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 231 Amazon WorkSpaces Service API Reference ModifySelfservicePermissions Modiﬁes the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users. Request Syntax { "ResourceId": "string", "SelfservicePermissions": { "ChangeComputeType": "string", "IncreaseVolumeSize": "string", "RebuildWorkspace": "string", "RestartWorkspace": "string", "SwitchRunningMode": "string" } } Request Parameters The request accepts the following data in JSON format. ResourceId The identiﬁer 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: Yes SelfservicePermissions The permissions to enable or disable self-service capabilities. Type: SelfservicePermissions object Required: Yes ModifySelfservicePermissions API Version 2015-04-08 232 Amazon WorkSpaces Service 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 See Also For more information about using this API in one of the language-speciﬁc 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 Response Elements API Version 2015-04-08 233 Amazon WorkSpaces Service • 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 234 Amazon WorkSpaces Service API Reference ModifyStreamingProperties Modiﬁes the speciﬁed streaming properties. Request Syntax { "ResourceId": "string", "StreamingProperties": { "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "StorageConnectors": [ { "ConnectorType": "string", "Status": "string" } ], "StreamingExperiencePreferredProtocol": "string", "UserSettings": [ { "Action": "string", "MaximumLength": number, "Permission": "string" } ] } } Request Parameters The request accepts the following data in JSON format. ResourceId The identiﬁer of the resource. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. ModifyStreamingProperties API Version 2015-04-08 235 Amazon WorkSpaces Service API Reference Pattern: ^(d-[0-9a-f]{8,63}$)\|(wsd-[0-9a-z]{8,63}$) Required: Yes StreamingProperties The streaming properties to conﬁgure. Type: StreamingProperties object 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 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 Response Elements API Version 2015-04-08 236 Amazon WorkSpaces Service See Also API Reference For more information about using this API in one of the language-speciﬁc 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 237 Amazon WorkSpaces Service API Reference ModifyWorkspaceAccessProperties Speciﬁes which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access. Request Syntax { "ResourceId": "string", "WorkspaceAccessProperties": { "DeviceTypeAndroid": "string", "DeviceTypeChromeOs": "string", "DeviceTypeIos": "string", "DeviceTypeLinux": "string", "DeviceTypeOsx": "string", "DeviceTypeWeb": "string", "DeviceTypeWindows": "string", "DeviceTypeWorkSpacesThinClient": "string", "DeviceTypeZeroClient": "string" } } Request Parameters The request accepts the following data in JSON format. ResourceId The identiﬁer 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: Yes WorkspaceAccessProperties The device types and operating systems to enable or disable for access. Type: WorkspaceAccessProperties object ModifyWorkspaceAccessProperties API Version 2015-04-08 238 Amazon WorkSpaces Service Required: Yes 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 ResourceNotFoundException The resource could not be found. HTTP
workspaces-api-042	workspaces-api.pdf	42	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 WorkspaceAccessProperties The device types and operating systems to enable or disable for access. Type: WorkspaceAccessProperties object ModifyWorkspaceAccessProperties API Version 2015-04-08 238 Amazon WorkSpaces Service Required: Yes 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 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-speciﬁc 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 Response Elements API Version 2015-04-08 239 Amazon WorkSpaces Service API Reference See Also API Version 2015-04-08 240 Amazon WorkSpaces Service API Reference ModifyWorkspaceCreationProperties Modify the default properties used to create WorkSpaces. Request Syntax { "ResourceId": "string", "WorkspaceCreationProperties": { "CustomSecurityGroupId": "string", "DefaultOu": "string", "EnableInternetAccess": boolean, "EnableMaintenanceMode": boolean, "InstanceIamRoleArn": "string", "UserEnabledAsLocalAdministrator": boolean } } Request Parameters The request accepts the following data in JSON format. ResourceId The identiﬁer 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: Yes WorkspaceCreationProperties The default properties for creating WorkSpaces. Type: WorkspaceCreationProperties object Required: Yes ModifyWorkspaceCreationProperties API Version 2015-04-08 241 Amazon WorkSpaces Service 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 See Also For more information about using this API in one of the language-speciﬁc 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 Response Elements API Version 2015-04-08 242 Amazon WorkSpaces Service • 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 243 Amazon WorkSpaces Service API Reference ModifyWorkspaceProperties Modiﬁes the speciﬁed WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace. Note The MANUAL running mode 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. Request Syntax { "DataReplication": "string", "WorkspaceId": "string", "WorkspaceProperties": { "ComputeTypeName": "string", "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "OperatingSystemName": "string", "Protocols": [ "string" ], "RootVolumeSizeGib": number, "RunningMode": "string", "RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": number } } Request Parameters The request accepts the following data in JSON format. DataReplication Indicates the data replication status. Type: String ModifyWorkspaceProperties API Version 2015-04-08 244 Amazon WorkSpaces Service API Reference Valid Values: NO_REPLICATION \| PRIMARY_AS_SOURCE Required: No WorkspaceId The identiﬁer of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: Yes WorkspaceProperties The properties of the WorkSpace. Type: WorkspaceProperties object 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 InvalidResourceStateException The state of the resource is not valid for this operation. Response Elements API Version 2015-04-08 245 Amazon WorkSpaces Service HTTP Status Code: 400 OperationInProgressException API Reference The properties of this WorkSpace are currently being modiﬁed. Try again in a moment. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 ResourceUnavailableException The speciﬁed resource is not available. HTTP Status Code: 400 UnsupportedWorkspaceConﬁgurationException The conﬁguration of this WorkSpace is not supported for this operation. For more information, see Required Conﬁguration and Service Components for WorkSpaces . HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET •
workspaces-api-043	workspaces-api.pdf	43	API Reference The properties of this WorkSpace are currently being modiﬁed. Try again in a moment. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 ResourceUnavailableException The speciﬁed resource is not available. HTTP Status Code: 400 UnsupportedWorkspaceConﬁgurationException The conﬁguration of this WorkSpace is not supported for this operation. For more information, see Required Conﬁguration and Service Components for WorkSpaces . HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 See Also API Version 2015-04-08 246 Amazon WorkSpaces Service • AWS SDK for Ruby V3 API Reference See Also API Version 2015-04-08 247 Amazon WorkSpaces Service API Reference ModifyWorkspaceState Sets the state of the speciﬁed WorkSpace. To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state. Request Syntax { "WorkspaceId": "string", "WorkspaceState": "string" } Request Parameters The request accepts the following data in JSON format. WorkspaceId The identiﬁer of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ Required: Yes WorkspaceState The WorkSpace state. Type: String Valid Values: AVAILABLE \| ADMIN_MAINTENANCE Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ModifyWorkspaceState API Version 2015-04-08 248 Amazon WorkSpaces Service Errors API Reference For information about the errors that are common to all actions, see Common Errors. 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 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-speciﬁc 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 Errors API Version 2015-04-08 249 Amazon WorkSpaces Service • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2015-04-08 250 Amazon WorkSpaces Service RebootWorkspaces Reboots the speciﬁed WorkSpaces. API Reference You cannot reboot a WorkSpace unless its state is AVAILABLE, UNHEALTHY, or REBOOTING. Reboot a WorkSpace in the REBOOTING state only if your WorkSpace has been stuck in the REBOOTING state for over 20 minutes. This operation is asynchronous and returns before the WorkSpaces have rebooted. Request Syntax { "RebootWorkspaceRequests": [ { "WorkspaceId": "string" } ] } Request Parameters The request accepts the following data in JSON format. RebootWorkspaceRequests The WorkSpaces to reboot. You can specify up to 25 WorkSpaces. Type: Array of RebootRequest objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: Yes Response Syntax { "FailedRequests": [ { "ErrorCode": "string", RebootWorkspaces API Version 2015-04-08 251 Amazon WorkSpaces Service API Reference "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 rebooted. Type: Array of FailedWorkspaceChangeRequest objects Errors For information about the errors that are common to all actions, see Common Errors. OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 Response Elements API Version 2015-04-08 252 Amazon WorkSpaces Service • 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 253 Amazon WorkSpaces Service RebuildWorkspaces Rebuilds the speciﬁed WorkSpace. API Reference You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING. Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace. This operation is asynchronous and returns before the WorkSpaces have
workspaces-api-044	workspaces-api.pdf	44	for JavaScript V3 Response Elements API Version 2015-04-08 252 Amazon WorkSpaces Service • 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 253 Amazon WorkSpaces Service RebuildWorkspaces Rebuilds the speciﬁed WorkSpace. API Reference You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING. Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace. This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt. Request Syntax { "RebuildWorkspaceRequests": [ { "WorkspaceId": "string" } ] } Request Parameters The request accepts the following data in JSON format. RebuildWorkspaceRequests The WorkSpace to rebuild. You can specify a single WorkSpace. Type: Array of RebuildRequest objects Array Members: Fixed number of 1 item. Required: Yes Response Syntax { "FailedRequests": [ RebuildWorkspaces API Version 2015-04-08 254 Amazon WorkSpaces Service API Reference { "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 WorkSpace that could not be rebuilt. Type: Array of FailedWorkspaceChangeRequest objects Errors For information about the errors that are common to all actions, see Common Errors. OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Response Elements API Version 2015-04-08 255 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 256 Amazon WorkSpaces Service API Reference RegisterWorkspaceDirectory Registers the speciﬁed directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the ﬁrst time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role. Request Syntax { "ActiveDirectoryConfig": { "DomainName": "string", "ServiceAccountSecretArn": "string" }, "DirectoryId": "string", "EnableSelfService": boolean, "IdcInstanceArn": "string", "MicrosoftEntraConfig": { "ApplicationConfigSecretArn": "string", "TenantId": "string" }, "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "Tenancy": "string", "UserIdentityType": "string", "WorkspaceDirectoryDescription": "string", "WorkspaceDirectoryName": "string", "WorkspaceType": "string" } Request Parameters The request accepts the following data in JSON format. ActiveDirectoryConﬁg The active directory conﬁg of the directory. RegisterWorkspaceDirectory API Version 2015-04-08 257 Amazon WorkSpaces Service API Reference Type: ActiveDirectoryConﬁg object Required: No DirectoryId The identiﬁer of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again. 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 EnableSelfService Indicates whether self-service capabilities are enabled or disabled. Type: Boolean Required: No IdcInstanceArn 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 MicrosoftEntraConﬁg The details about Microsoft Entra conﬁg. Request Parameters API Version 2015-04-08 258 Amazon WorkSpaces Service API Reference Type: MicrosoftEntraConﬁg object Required: No SubnetIds The identiﬁers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error. 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 Tags The tags associated with the directory. Type: Array of Tag objects Required: No Tenancy Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your AWS account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images. Type: String Valid Values: DEDICATED \| SHARED Required: No UserIdentityType The type of identity management the user is using. Request Parameters API Version 2015-04-08 259 Amazon WorkSpaces Service Type: String API Reference Valid Values: CUSTOMER_MANAGED \| AWS_DIRECTORY_SERVICE \| AWS_IAM_IDENTITY_CENTER Required: No WorkspaceDirectoryDescription Description of the directory
workspaces-api-045	workspaces-api.pdf	45	or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your AWS account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images. Type: String Valid Values: DEDICATED \| SHARED Required: No UserIdentityType The type of identity management the user is using. Request Parameters API Version 2015-04-08 259 Amazon WorkSpaces Service Type: String API Reference Valid Values: CUSTOMER_MANAGED \| AWS_DIRECTORY_SERVICE \| AWS_IAM_IDENTITY_CENTER Required: No WorkspaceDirectoryDescription Description of the directory to register. Type: String Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]{1,255}$ Required: No WorkspaceDirectoryName The name of the directory to register. Type: String Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.\s-]{1,64}$ Required: No WorkspaceType Indicates whether the directory's WorkSpace type is personal or pools. Type: String Valid Values: PERSONAL \| POOLS Required: No Response Syntax { "DirectoryId": "string", "State": "string" } Response Syntax API Version 2015-04-08 260 Amazon WorkSpaces Service Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DirectoryId The identiﬁer 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}$) State The registration status of the WorkSpace directory. Type: String Valid Values: REGISTERING \| REGISTERED \| DEREGISTERING \| DEREGISTERED \| ERROR 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 261 API Reference Amazon WorkSpaces Service HTTP Status Code: 400 OperationNotSupportedException This operation is not supported. HTTP Status Code: 400 ResourceAlreadyExistsException The speciﬁed resource already exists. 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 UnsupportedNetworkConﬁgurationException The conﬁguration of this network is not supported for this operation, or your network conﬁguration conﬂicts with the Amazon WorkSpaces management network IP range. For more information, see Conﬁgure a VPC for Amazon WorkSpaces. HTTP Status Code: 400 WorkspacesDefaultRoleNotFoundException The workspaces_DefaultRole role could not be found. If this is the ﬁrst time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2015-04-08 262 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 263 Amazon WorkSpaces Service API Reference RejectAccountLinkInvitation Rejects the account link invitation. Request Syntax { "ClientToken": "string", "LinkId": "string" } Request Parameters The request accepts the following data in JSON format. ClientToken The client token of the account link invitation to reject. Type: String Pattern: ^.{1,64}$ Required: No LinkId The identiﬁer of the account link Type: String Pattern: ^link-.{8,24}$ Required: Yes Response Syntax { "AccountLink": { "AccountLinkId": "string", "AccountLinkStatus": "string", RejectAccountLinkInvitation API Version 2015-04-08 264 Amazon WorkSpaces Service API Reference "SourceAccountId": "string", "TargetAccountId": "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. AccountLink Information about the account link. Type: AccountLink 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 ConﬂictException The TargetAccountId is already linked or invited. HTTP Status Code: 400 InternalServerException Unexpected server error occured. HTTP Status Code: 400 ResourceNotFoundException The resource could not be found. HTTP Status Code: 400 Response Elements API Version 2015-04-08 265 Amazon WorkSpaces Service ValidationException API Reference You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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
workspaces-api-046	workspaces-api.pdf	46	265 Amazon WorkSpaces Service ValidationException API Reference You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc 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 266 Amazon WorkSpaces Service RestoreWorkspace API Reference Restores the speciﬁed WorkSpace to its last known healthy state. You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED. Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace. This operation is asynchronous and returns before the WorkSpace is completely restored. Request Syntax { "WorkspaceId": "string" } Request Parameters The request accepts the following data in JSON format. WorkspaceId The identiﬁer of the WorkSpace. Type: String Pattern: ^ws-[0-9a-z]{8,63}$ 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. RestoreWorkspace API Version 2015-04-08 267 API Reference Amazon WorkSpaces Service 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 See Also For more information about using this API in one of the language-speciﬁc 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 268 Amazon WorkSpaces Service RevokeIpRules API Reference Removes one or more rules from the speciﬁed IP access control group. Request Syntax { "GroupId": "string", "UserRules": [ "string" ] } Request Parameters The request accepts the following data in JSON format. GroupId The identiﬁer of the group. Type: String Pattern: wsipg-[0-9a-z]{8,63}$ Required: Yes UserRules The rules to remove from the group. Type: Array of strings 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. RevokeIpRules API Version 2015-04-08 269 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 InvalidResourceStateException The state of the resource is not valid for this operation. 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-speciﬁc 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 270 Amazon WorkSpaces Service StartWorkspaces Starts the speciﬁed WorkSpaces. API Reference You cannot start a WorkSpace unless it has a running mode of AutoStop or Manual and a state of STOPPED. Request Syntax { "StartWorkspaceRequests": [ { "WorkspaceId": "string" } ] } Request Parameters The request accepts the following data in JSON format. StartWorkspaceRequests The WorkSpaces to start. You can specify up to 25 WorkSpaces. Type: Array of StartRequest objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: Yes Response Syntax { "FailedRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "WorkspaceId": "string" } StartWorkspaces API Version 2015-04-08 271 Amazon WorkSpaces Service API Reference ] } 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 started. Type: Array of FailedWorkspaceChangeRequest objects Errors 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-speciﬁc AWS SDKs, see the
workspaces-api-047	workspaces-api.pdf	47	Yes Response Syntax { "FailedRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "WorkspaceId": "string" } StartWorkspaces API Version 2015-04-08 271 Amazon WorkSpaces Service API Reference ] } 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 started. Type: Array of FailedWorkspaceChangeRequest objects Errors 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-speciﬁc 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 Response Elements API Version 2015-04-08 272 Amazon WorkSpaces Service API Reference StartWorkspacesPool Starts the speciﬁed pool. You cannot start a pool unless it has a running mode of AutoStop and a state of STOPPED. Request Syntax { "PoolId": "string" } Request Parameters The request accepts the following data in JSON format. PoolId The identiﬁer 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 StartWorkspacesPool API Version 2015-04-08 273 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 modiﬁed. 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-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2015-04-08 274 Amazon WorkSpaces Service • 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 2015-04-08 275 Amazon WorkSpaces Service StopWorkspaces Stops the speciﬁed WorkSpaces. API Reference You cannot stop a WorkSpace unless it has a running mode of AutoStop or Manual and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR. Request Syntax { "StopWorkspaceRequests": [ { "WorkspaceId": "string" } ] } Request Parameters The request accepts the following data in JSON format. StopWorkspaceRequests The WorkSpaces to stop. You can specify up to 25 WorkSpaces. Type: Array of StopRequest objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: Yes Response Syntax { "FailedRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "WorkspaceId": "string" } StopWorkspaces API Version 2015-04-08 276 Amazon WorkSpaces Service API Reference ] } 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 stopped. Type: Array of FailedWorkspaceChangeRequest objects Errors 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-speciﬁc 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 Response Elements API Version 2015-04-08 277 Amazon WorkSpaces Service API Reference StopWorkspacesPool Stops the speciﬁed 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 identiﬁer 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

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.