amazon-workspaces — quality + safety report

---
name: amazon-workspaces
description: "Amazon WorkSpaces API skill. Use when working with Amazon WorkSpaces for root. Covers 88 endpoints."
version: 1.0.0
generator: lapsh
---

# Amazon WorkSpaces
API version: 2015-04-08

## Auth
AWS SigV4

## Base URL
Not specified.

## Setup
1. Configure auth: AWS SigV4
3. POST / -- create first resource

## Endpoints

88 endpoints across 1 groups. See references/api-spec.lap for full details.

### root
| Method | Path | Description |
|--------|------|-------------|
| POST | / | Accepts the account link invitation.  There's currently no unlinking capability after you accept the account linking invitation. |
| POST | / | Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see  Cross-Region Redirection for Amazon WorkSpaces.  Before performing this operation, call  DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED. |
| POST | / | Associates the specified IP access control group with the specified directory. |
| POST | / | Associates the specified application to the specified WorkSpace. |
| POST | / | Adds one or more rules to the specified IP access control group. This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules. |
| POST | / | Copies the specified image from the specified 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 Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.  Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations. |
| POST | / | Creates the account link invitation. |
| POST | / | 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. |
| POST | / | Creates the specified connection alias for use with cross-Region redirection. For more information, see  Cross-Region Redirection for Amazon WorkSpaces. |
| POST | / | Creates an IP access control group. 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. |
| POST | / | Creates a standby WorkSpace in a secondary Region. |
| POST | / | Creates the specified tags for the specified WorkSpaces resource. |
| POST | / | Creates a new updated WorkSpace image based on the specified 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.    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 verified your new updated image and created a new bundle. |
| POST | / | Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see  Create a Custom WorkSpaces Image and Bundle. |
| POST | / | Creates a new WorkSpace image from an existing WorkSpace. |
| POST | / | Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created.    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 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? |
| POST | / | Creates a pool of WorkSpaces. |
| POST | / | Deletes the account link invitation. |
| POST | / | 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. |
| POST | / | Deletes a client-add-in for Amazon Connect that is configured within a directory. |
| POST | / | Deletes the specified connection alias. For more information, see  Cross-Region Redirection for Amazon WorkSpaces.   If you will no longer be using a fully qualified 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.   To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories. |
| POST | / | Deletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory. |
| POST | / | Deletes the specified tags from the specified WorkSpaces resource. |
| POST | / | Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see  Delete a Custom WorkSpaces Bundle or Image. |
| POST | / | Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts. |
| POST | / | Deploys associated applications to the specified WorkSpace |
| POST | / | Deregisters the specified 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.  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 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. |
| POST | / | Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account. |
| POST | / | Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account. |
| POST | / | Describes the associations between the application and the specified associated resources. |
| POST | / | Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners. |
| POST | / | Describes the associations between the applications and the specified bundle. |
| POST | / | Describes the specified 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.  Only device types that have branding information configured will be shown in the response. |
| POST | / | Retrieves a list that describes one or more specified Amazon WorkSpaces clients. |
| POST | / | Retrieves a list of Amazon Connect client add-ins that have been created. |
| POST | / | Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see  Cross-Region Redirection for Amazon WorkSpaces. |
| POST | / | Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see  Cross-Region Redirection for Amazon WorkSpaces. |
| POST | / | Describes the associations between the applications and the specified image. |
| POST | / | Describes one or more of your IP access control groups. |
| POST | / | Describes the specified tags for the specified WorkSpaces resource. |
| POST | / | Describes the associations betweens applications and the specified WorkSpace. |
| POST | / | Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both. |
| POST | / | Describes the available directories that are registered with Amazon WorkSpaces. |
| POST | / | Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image. |
| POST | / | Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described. |
| POST | / | Describes the snapshots for the specified WorkSpace. |
| POST | / | Describes the specified WorkSpaces. You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time. |
| POST | / | Describes the connection status of the specified WorkSpaces. |
| POST | / | Retrieves a list that describes the streaming sessions for a specified pool. |
| POST | / | Describes the specified WorkSpaces Pools. |
| POST | / | Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see  Cross-Region Redirection for Amazon WorkSpaces.  Before performing this operation, call  DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED. |
| POST | / | Disassociates the specified IP access control group from the specified directory. |
| POST | / | Disassociates the specified application from a WorkSpace. |
| POST | / | Retrieves account link information. |
| POST | / | 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 specified platform type is replaced with the imported experience    You must specify at least one

… (truncated)