From f7d75a0c0424a5174538a10ddc0e1d060b5bb7df Mon Sep 17 00:00:00 2001 From: awstools Date: Thu, 31 Mar 2022 18:23:42 +0000 Subject: [PATCH] feat(client-workspaces): Added APIs that allow you to customize the logo, login message, and help links in the WorkSpaces client login page. To learn more, visit https://docs.aws.amazon.com/workspaces/latest/adminguide/customize-branding.html --- clients/client-workspaces/README.md | 18 +- clients/client-workspaces/src/WorkSpaces.ts | 435 +- .../client-workspaces/src/WorkSpacesClient.ts | 36 +- .../AssociateConnectionAliasCommand.ts | 10 +- .../src/commands/CopyWorkspaceImageCommand.ts | 14 +- .../CreateConnectClientAddInCommand.ts | 1 - .../commands/CreateConnectionAliasCommand.ts | 6 +- .../src/commands/CreateIpGroupCommand.ts | 1 - .../CreateUpdatedWorkspaceImageCommand.ts | 24 +- .../commands/DeleteClientBrandingCommand.ts | 100 + .../commands/DeleteConnectionAliasCommand.ts | 20 +- .../DeregisterWorkspaceDirectoryCommand.ts | 27 +- .../commands/DescribeClientBrandingCommand.ts | 102 + ...scribeConnectionAliasPermissionsCommand.ts | 7 +- .../DescribeConnectionAliasesCommand.ts | 6 +- .../DescribeWorkspaceDirectoriesCommand.ts | 3 +- ...escribeWorkspaceImagePermissionsCommand.ts | 3 +- .../DisassociateConnectionAliasCommand.ts | 12 +- .../commands/ImportClientBrandingCommand.ts | 122 + .../commands/ImportWorkspaceImageCommand.ts | 7 +- ...istAvailableManagementCidrRangesCommand.ts | 7 +- .../src/commands/MigrateWorkspaceCommand.ts | 20 +- .../ModifyWorkspacePropertiesCommand.ts | 6 +- .../src/commands/RebuildWorkspacesCommand.ts | 3 +- .../RegisterWorkspaceDirectoryCommand.ts | 8 +- .../commands/TerminateWorkspacesCommand.ts | 29 +- .../UpdateConnectionAliasPermissionCommand.ts | 24 +- .../UpdateWorkspaceImagePermissionCommand.ts | 29 +- .../client-workspaces/src/commands/index.ts | 3 + .../client-workspaces/src/models/models_0.ts | 847 +- .../src/protocols/Aws_json1_1.ts | 437 + .../sdk-codegen/aws-models/workspaces.json | 12425 ++++++++-------- 32 files changed, 8406 insertions(+), 6386 deletions(-) create mode 100644 clients/client-workspaces/src/commands/DeleteClientBrandingCommand.ts create mode 100644 clients/client-workspaces/src/commands/DescribeClientBrandingCommand.ts create mode 100644 clients/client-workspaces/src/commands/ImportClientBrandingCommand.ts diff --git a/clients/client-workspaces/README.md b/clients/client-workspaces/README.md index c4be7341f1f5..188a8b7ac976 100644 --- a/clients/client-workspaces/README.md +++ b/clients/client-workspaces/README.md @@ -9,8 +9,22 @@ AWS SDK for JavaScript WorkSpaces Client for Node.js, Browser and React Native. Amazon WorkSpaces Service -

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and -Amazon Linux desktops for your users.

+

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 Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services +General Reference.

+

You can also manage your WorkSpaces resources using the WorkSpaces +console, Command Line Interface (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 CLI to manage your WorkSpaces resources, +see the WorkSpaces section of the CLI Reference.

## Installing diff --git a/clients/client-workspaces/src/WorkSpaces.ts b/clients/client-workspaces/src/WorkSpaces.ts index a8af3929e223..b77c2f600b21 100644 --- a/clients/client-workspaces/src/WorkSpaces.ts +++ b/clients/client-workspaces/src/WorkSpaces.ts @@ -51,6 +51,11 @@ import { CreateWorkspacesCommandInput, CreateWorkspacesCommandOutput, } from "./commands/CreateWorkspacesCommand"; +import { + DeleteClientBrandingCommand, + DeleteClientBrandingCommandInput, + DeleteClientBrandingCommandOutput, +} from "./commands/DeleteClientBrandingCommand"; import { DeleteConnectClientAddInCommand, DeleteConnectClientAddInCommandInput, @@ -92,6 +97,11 @@ import { DescribeAccountModificationsCommandInput, DescribeAccountModificationsCommandOutput, } from "./commands/DescribeAccountModificationsCommand"; +import { + DescribeClientBrandingCommand, + DescribeClientBrandingCommandInput, + DescribeClientBrandingCommandOutput, +} from "./commands/DescribeClientBrandingCommand"; import { DescribeClientPropertiesCommand, DescribeClientPropertiesCommandInput, @@ -167,6 +177,11 @@ import { DisassociateIpGroupsCommandInput, DisassociateIpGroupsCommandOutput, } from "./commands/DisassociateIpGroupsCommand"; +import { + ImportClientBrandingCommand, + ImportClientBrandingCommandInput, + ImportClientBrandingCommandOutput, +} from "./commands/ImportClientBrandingCommand"; import { ImportWorkspaceImageCommand, ImportWorkspaceImageCommandInput, @@ -286,18 +301,32 @@ import { WorkSpacesClient } from "./WorkSpacesClient"; /** * Amazon WorkSpaces Service - *

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and - * Amazon Linux desktops for your users.

+ *

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 Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services + * General Reference.

+ *

You can also manage your WorkSpaces resources using the WorkSpaces + * console, Command Line Interface (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 CLI to manage your WorkSpaces resources, + * see the WorkSpaces section of the CLI Reference.

*/ export class WorkSpaces extends WorkSpacesClient { /** - *

Associates the specified connection alias with the specified directory to enable cross-Region redirection. - * For more information, see - * Cross-Region Redirection for Amazon WorkSpaces.

- * + *

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.

+ * DescribeConnectionAliases to make sure that the current state of the + * connection alias is CREATED.

* */ public associateConnectionAlias( @@ -396,19 +425,15 @@ export class WorkSpaces extends WorkSpacesClient { } /** - *

Copies the specified image from the specified Region to the current Region. - * For more information about copying images, see - * - * Copy a Custom WorkSpaces Image.

- * + *

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.

+ * 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.

* */ public copyWorkspaceImage( @@ -443,7 +468,6 @@ export class WorkSpaces extends WorkSpacesClient { /** *

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.

*/ public createConnectClientAddIn( @@ -476,9 +500,9 @@ export class WorkSpaces extends WorkSpacesClient { } /** - *

Creates the specified connection alias for use with cross-Region redirection. For more information, see - * - * Cross-Region Redirection for Amazon WorkSpaces.

+ *

Creates the specified connection alias for use with cross-Region redirection. For more + * information, see Cross-Region + * Redirection for Amazon WorkSpaces.

*/ public createConnectionAlias( args: CreateConnectionAliasCommandInput, @@ -515,7 +539,6 @@ export class WorkSpaces extends WorkSpacesClient { * 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 @@ -577,27 +600,25 @@ export class WorkSpaces extends WorkSpacesClient { } /** - *

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 - * + *

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.

- * * * * @@ -698,6 +719,43 @@ export class WorkSpaces extends WorkSpacesClient { } } + /** + *

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.

+ */ + public deleteClientBranding( + args: DeleteClientBrandingCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public deleteClientBranding( + args: DeleteClientBrandingCommandInput, + cb: (err: any, data?: DeleteClientBrandingCommandOutput) => void + ): void; + public deleteClientBranding( + args: DeleteClientBrandingCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DeleteClientBrandingCommandOutput) => void + ): void; + public deleteClientBranding( + args: DeleteClientBrandingCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteClientBrandingCommandOutput) => void), + cb?: (err: any, data?: DeleteClientBrandingCommandOutput) => void + ): Promise | void { + const command = new DeleteClientBrandingCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

Deletes a client-add-in for Amazon Connect that is configured within a * directory.

@@ -733,21 +791,19 @@ export class WorkSpaces extends WorkSpacesClient { /** *

Deletes the specified connection alias. For more information, see - * Cross-Region Redirection for Amazon WorkSpaces.

- * + * 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.

+ * 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 + *

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.

* */ @@ -908,22 +964,19 @@ export class WorkSpaces extends WorkSpacesClient { } /** - *

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.

- * + *

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.

+ *

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.

* */ public deregisterWorkspaceDirectory( @@ -1021,6 +1074,45 @@ export class WorkSpaces extends WorkSpacesClient { } } + /** + *

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.

+ * + */ + public describeClientBranding( + args: DescribeClientBrandingCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public describeClientBranding( + args: DescribeClientBrandingCommandInput, + cb: (err: any, data?: DescribeClientBrandingCommandOutput) => void + ): void; + public describeClientBranding( + args: DescribeClientBrandingCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DescribeClientBrandingCommandOutput) => void + ): void; + public describeClientBranding( + args: DescribeClientBrandingCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeClientBrandingCommandOutput) => void), + cb?: (err: any, data?: DescribeClientBrandingCommandOutput) => void + ): Promise | void { + const command = new DescribeClientBrandingCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

*/ @@ -1086,9 +1178,9 @@ export class WorkSpaces extends WorkSpacesClient { } /** - *

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see - * - * Cross-Region Redirection for Amazon WorkSpaces.

+ *

Retrieves a list that describes the connection aliases used for cross-Region + * redirection. For more information, see Cross-Region + * Redirection for Amazon WorkSpaces.

*/ public describeConnectionAliases( args: DescribeConnectionAliasesCommandInput, @@ -1120,9 +1212,10 @@ export class WorkSpaces extends WorkSpacesClient { } /** - *

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.

+ *

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.

*/ public describeConnectionAliasPermissions( args: DescribeConnectionAliasPermissionsCommandInput, @@ -1248,8 +1341,7 @@ export class WorkSpaces extends WorkSpacesClient { } /** - *

Describes the available directories that are registered with - * Amazon WorkSpaces.

+ *

Describes the available directories that are registered with Amazon WorkSpaces.

*/ public describeWorkspaceDirectories( args: DescribeWorkspaceDirectoriesCommandInput, @@ -1281,8 +1373,7 @@ export class WorkSpaces extends WorkSpacesClient { } /** - *

Describes the permissions that the owner of an image has granted to other - * Amazon Web Services accounts for an image.

+ *

Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.

*/ public describeWorkspaceImagePermissions( args: DescribeWorkspaceImagePermissionsCommandInput, @@ -1445,14 +1536,14 @@ export class WorkSpaces extends WorkSpacesClient { } /** - *

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.

- * + *

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.

+ * DescribeConnectionAliases to make sure that the current state of the + * connection alias is CREATED.

* */ public disassociateConnectionAlias( @@ -1516,12 +1607,70 @@ export class WorkSpaces extends WorkSpacesClient { } } + /** + *

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 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 different 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.

    + *
    • + *
+ * + */ + public importClientBranding( + args: ImportClientBrandingCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public importClientBranding( + args: ImportClientBrandingCommandInput, + cb: (err: any, data?: ImportClientBrandingCommandOutput) => void + ): void; + public importClientBranding( + args: ImportClientBrandingCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ImportClientBrandingCommandOutput) => void + ): void; + public importClientBranding( + args: ImportClientBrandingCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportClientBrandingCommandOutput) => void), + cb?: (err: any, data?: ImportClientBrandingCommandOutput) => void + ): Promise | void { + const command = new ImportClientBrandingCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon - * WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your - * Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see - * - * Bring Your Own Windows Desktop Licenses.

+ * WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL + * images, see Bring Your Own Windows + * Desktop Licenses.

*/ public importWorkspaceImage( args: ImportWorkspaceImageCommandInput, @@ -1555,10 +1704,9 @@ export class WorkSpaces extends WorkSpacesClient { /** *

Retrieves a list of IP address ranges, specified 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 Amazon Web Services accounts that are enabled for BYOL. If your account - * isn't enabled for BYOL, you'll receive an AccessDeniedException error.

- * + *

This operation can be run only by Amazon Web Services 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.

@@ -1593,15 +1741,17 @@ export class WorkSpaces extends WorkSpacesClient { } /** - *

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 profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ - * folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.

- * - *

For available migration scenarios, details about what happens during migration, and best practices, see - * Migrate a WorkSpace.

+ *

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 profile + * folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new + * D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in + * the old user profile are moved to the new user profile.

+ *

For available migration scenarios, details about what happens during migration, and best + * practices, see Migrate a + * WorkSpace.

*/ public migrateWorkspace( args: MigrateWorkspaceCommandInput, @@ -1797,10 +1947,8 @@ export class WorkSpaces extends WorkSpacesClient { } /** - *

Modifies the specified WorkSpace properties. For important information about how - * to modify the size of the root and user volumes, see - * - * Modify a WorkSpace. + *

Modifies the specified WorkSpace properties. For important information about how to + * modify the size of the root and user volumes, see Modify a WorkSpace. *

*/ public modifyWorkspaceProperties( @@ -1907,7 +2055,8 @@ export class WorkSpaces extends WorkSpacesClient { /** *

Rebuilds the specified WorkSpace.

*

You cannot rebuild a WorkSpace unless its state is AVAILABLE, - * ERROR, UNHEALTHY, STOPPED, or REBOOTING.

+ * 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.

@@ -1944,10 +2093,10 @@ export class WorkSpaces extends WorkSpacesClient { } /** - *

Registers the specified directory. This operation is asynchronous - * and returns before the WorkSpace directory is registered. If this is the first 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 + *

Registers the specified directory. This operation is asynchronous and returns before the + * WorkSpace directory is registered. If this is the first 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.

*/ public registerWorkspaceDirectory( @@ -2121,34 +2270,29 @@ export class WorkSpaces extends WorkSpacesClient { /** *

Terminates the specified WorkSpaces.

- * * - *

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is - * destroyed. If you need to archive any user data, contact Amazon Web Services Support before + *

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data + * is destroyed. If you need to archive any user data, contact Amazon Web Services Support before * terminating the WorkSpace.

* - * *

You can terminate a WorkSpace that is in any state except SUSPENDED.

*

This operation is asynchronous and returns before the WorkSpaces have been completely * terminated. After a WorkSpace is terminated, the TERMINATED state is returned * only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely * returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using - * + * * DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has * been successfully terminated.

- * * - *

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.

+ *

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.

* */ public terminateWorkspaces( @@ -2214,23 +2358,25 @@ export class WorkSpaces extends WorkSpacesClient { } /** - *

Shares or unshares a connection alias with one account by specifying whether that account has permission to - * associate the connection alias with a directory. If the association permission is granted, the connection alias - * is shared with that account. If the association permission is revoked, the connection alias is unshared with the - * account. For more information, see - * Cross-Region Redirection for Amazon WorkSpaces.

- * + *

Shares or unshares a connection alias with one account by specifying whether that + * account has permission to associate the connection alias with a directory. If the + * association permission is granted, the connection alias is shared with that account. If the + * association permission is revoked, the connection alias is unshared with the account. For + * more information, see Cross-Region + * Redirection for Amazon WorkSpaces.

* *
    *
  • *

    Before performing this operation, call - * DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

    + * DescribeConnectionAliases to make sure that the current state of the + * connection alias is CREATED.

    *
    • *
  • - *

    To delete a connection alias that has been shared, the shared account must first disassociate the - * connection alias from any directories it has been associated with. Then you must unshare the connection - * alias from the account it has been shared with. You can delete a connection alias only after it is no - * longer shared with any accounts or associated with any directories.

    + *

    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.

    *
    • *
* @@ -2338,29 +2484,26 @@ export class WorkSpaces extends WorkSpacesClient { } /** - *

Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has - * permission to copy the image. If the copy image permission is granted, the image is shared with that account. - * If the copy image permission is revoked, the image is unshared with the account.

- * - *

After an image has been shared, the recipient account can copy the image to other Regions as needed.

- * + *

Shares or unshares an image with one account in the same Amazon Web Services Region by + * specifying whether that account has permission to copy the image. If the copy image + * permission is granted, the image is shared with that account. If the copy image permission + * is revoked, the image is unshared with the account.

+ *

After an image has been shared, the recipient account can copy the image to other + * Regions as needed.

*

In the China (Ningxia) Region, you can copy images only within the same Region.

- * *

In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

- * - *

For more information about sharing images, see - * - * Share or Unshare a Custom WorkSpaces Image.

- * + *

For more information about sharing images, see Share or Unshare a Custom + * WorkSpaces Image.

* *
    *
  • - *

    To delete an image that has been shared, you must unshare the image before you delete it.

    + *

    To delete an image that has been shared, you must unshare the image before you + * delete it.

    *
    • *
  • - *

    Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at - * this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in - * Amazon Web Services GovCloud (US), contact Amazon Web Services Support.

    + *

    Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts + * isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images + * across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.

    *
    • *
* diff --git a/clients/client-workspaces/src/WorkSpacesClient.ts b/clients/client-workspaces/src/WorkSpacesClient.ts index 7d55cb453cf9..2bf289bae7bf 100644 --- a/clients/client-workspaces/src/WorkSpacesClient.ts +++ b/clients/client-workspaces/src/WorkSpacesClient.ts @@ -77,6 +77,10 @@ import { CreateWorkspaceBundleCommandOutput, } from "./commands/CreateWorkspaceBundleCommand"; import { CreateWorkspacesCommandInput, CreateWorkspacesCommandOutput } from "./commands/CreateWorkspacesCommand"; +import { + DeleteClientBrandingCommandInput, + DeleteClientBrandingCommandOutput, +} from "./commands/DeleteClientBrandingCommand"; import { DeleteConnectClientAddInCommandInput, DeleteConnectClientAddInCommandOutput, @@ -104,6 +108,10 @@ import { DescribeAccountModificationsCommandInput, DescribeAccountModificationsCommandOutput, } from "./commands/DescribeAccountModificationsCommand"; +import { + DescribeClientBrandingCommandInput, + DescribeClientBrandingCommandOutput, +} from "./commands/DescribeClientBrandingCommand"; import { DescribeClientPropertiesCommandInput, DescribeClientPropertiesCommandOutput, @@ -155,6 +163,10 @@ import { DisassociateIpGroupsCommandInput, DisassociateIpGroupsCommandOutput, } from "./commands/DisassociateIpGroupsCommand"; +import { + ImportClientBrandingCommandInput, + ImportClientBrandingCommandOutput, +} from "./commands/ImportClientBrandingCommand"; import { ImportWorkspaceImageCommandInput, ImportWorkspaceImageCommandOutput, @@ -237,6 +249,7 @@ export type ServiceInputTypes = | CreateUpdatedWorkspaceImageCommandInput | CreateWorkspaceBundleCommandInput | CreateWorkspacesCommandInput + | DeleteClientBrandingCommandInput | DeleteConnectClientAddInCommandInput | DeleteConnectionAliasCommandInput | DeleteIpGroupCommandInput @@ -246,6 +259,7 @@ export type ServiceInputTypes = | DeregisterWorkspaceDirectoryCommandInput | DescribeAccountCommandInput | DescribeAccountModificationsCommandInput + | DescribeClientBrandingCommandInput | DescribeClientPropertiesCommandInput | DescribeConnectClientAddInsCommandInput | DescribeConnectionAliasPermissionsCommandInput @@ -261,6 +275,7 @@ export type ServiceInputTypes = | DescribeWorkspacesConnectionStatusCommandInput | DisassociateConnectionAliasCommandInput | DisassociateIpGroupsCommandInput + | ImportClientBrandingCommandInput | ImportWorkspaceImageCommandInput | ListAvailableManagementCidrRangesCommandInput | MigrateWorkspaceCommandInput @@ -297,6 +312,7 @@ export type ServiceOutputTypes = | CreateUpdatedWorkspaceImageCommandOutput | CreateWorkspaceBundleCommandOutput | CreateWorkspacesCommandOutput + | DeleteClientBrandingCommandOutput | DeleteConnectClientAddInCommandOutput | DeleteConnectionAliasCommandOutput | DeleteIpGroupCommandOutput @@ -306,6 +322,7 @@ export type ServiceOutputTypes = | DeregisterWorkspaceDirectoryCommandOutput | DescribeAccountCommandOutput | DescribeAccountModificationsCommandOutput + | DescribeClientBrandingCommandOutput | DescribeClientPropertiesCommandOutput | DescribeConnectClientAddInsCommandOutput | DescribeConnectionAliasPermissionsCommandOutput @@ -321,6 +338,7 @@ export type ServiceOutputTypes = | DescribeWorkspacesConnectionStatusCommandOutput | DisassociateConnectionAliasCommandOutput | DisassociateIpGroupsCommandOutput + | ImportClientBrandingCommandOutput | ImportWorkspaceImageCommandOutput | ListAvailableManagementCidrRangesCommandOutput | MigrateWorkspaceCommandOutput @@ -500,8 +518,22 @@ export interface WorkSpacesClientResolvedConfig extends WorkSpacesClientResolved /** * Amazon WorkSpaces Service - *

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and - * Amazon Linux desktops for your users.

+ *

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 Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services + * General Reference.

+ *

You can also manage your WorkSpaces resources using the WorkSpaces + * console, Command Line Interface (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 CLI to manage your WorkSpaces resources, + * see the WorkSpaces section of the CLI Reference.

*/ export class WorkSpacesClient extends __Client< __HttpHandlerOptions, diff --git a/clients/client-workspaces/src/commands/AssociateConnectionAliasCommand.ts b/clients/client-workspaces/src/commands/AssociateConnectionAliasCommand.ts index 90b42ce735e3..fc4634ce0212 100644 --- a/clients/client-workspaces/src/commands/AssociateConnectionAliasCommand.ts +++ b/clients/client-workspaces/src/commands/AssociateConnectionAliasCommand.ts @@ -22,13 +22,13 @@ export interface AssociateConnectionAliasCommandInput extends AssociateConnectio export interface AssociateConnectionAliasCommandOutput extends AssociateConnectionAliasResult, __MetadataBearer {} /** - *

Associates the specified connection alias with the specified directory to enable cross-Region redirection. - * For more information, see - * Cross-Region Redirection for Amazon WorkSpaces.

- * + *

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.

+ * DescribeConnectionAliases to make sure that the current state of the + * connection alias is CREATED.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-workspaces/src/commands/CopyWorkspaceImageCommand.ts b/clients/client-workspaces/src/commands/CopyWorkspaceImageCommand.ts index 94fc4672ee14..d9d3428e1624 100644 --- a/clients/client-workspaces/src/commands/CopyWorkspaceImageCommand.ts +++ b/clients/client-workspaces/src/commands/CopyWorkspaceImageCommand.ts @@ -22,19 +22,15 @@ export interface CopyWorkspaceImageCommandInput extends CopyWorkspaceImageReques export interface CopyWorkspaceImageCommandOutput extends CopyWorkspaceImageResult, __MetadataBearer {} /** - *

Copies the specified image from the specified Region to the current Region. - * For more information about copying images, see - * - * Copy a Custom WorkSpaces Image.

- * + *

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.

+ * 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.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-workspaces/src/commands/CreateConnectClientAddInCommand.ts b/clients/client-workspaces/src/commands/CreateConnectClientAddInCommand.ts index 98a7f75fd9c1..9061cdd73043 100644 --- a/clients/client-workspaces/src/commands/CreateConnectClientAddInCommand.ts +++ b/clients/client-workspaces/src/commands/CreateConnectClientAddInCommand.ts @@ -24,7 +24,6 @@ export interface CreateConnectClientAddInCommandOutput extends CreateConnectClie /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-workspaces/src/commands/CreateConnectionAliasCommand.ts b/clients/client-workspaces/src/commands/CreateConnectionAliasCommand.ts index b88f99721a4c..79e072ea1657 100644 --- a/clients/client-workspaces/src/commands/CreateConnectionAliasCommand.ts +++ b/clients/client-workspaces/src/commands/CreateConnectionAliasCommand.ts @@ -22,9 +22,9 @@ export interface CreateConnectionAliasCommandInput extends CreateConnectionAlias export interface CreateConnectionAliasCommandOutput extends CreateConnectionAliasResult, __MetadataBearer {} /** - *

Creates the specified connection alias for use with cross-Region redirection. For more information, see - * - * Cross-Region Redirection for Amazon WorkSpaces.

+ *

Creates the specified connection alias for use with cross-Region redirection. For more + * information, see Cross-Region + * Redirection for Amazon WorkSpaces.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-workspaces/src/commands/CreateIpGroupCommand.ts b/clients/client-workspaces/src/commands/CreateIpGroupCommand.ts index 22130553977d..b696c66b6e5e 100644 --- a/clients/client-workspaces/src/commands/CreateIpGroupCommand.ts +++ b/clients/client-workspaces/src/commands/CreateIpGroupCommand.ts @@ -27,7 +27,6 @@ export interface CreateIpGroupCommandOutput extends CreateIpGroupResult, __Metad * 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 diff --git a/clients/client-workspaces/src/commands/CreateUpdatedWorkspaceImageCommand.ts b/clients/client-workspaces/src/commands/CreateUpdatedWorkspaceImageCommand.ts index b634cfcc5f32..f71287cee165 100644 --- a/clients/client-workspaces/src/commands/CreateUpdatedWorkspaceImageCommand.ts +++ b/clients/client-workspaces/src/commands/CreateUpdatedWorkspaceImageCommand.ts @@ -22,27 +22,25 @@ export interface CreateUpdatedWorkspaceImageCommandInput extends CreateUpdatedWo export interface CreateUpdatedWorkspaceImageCommandOutput extends CreateUpdatedWorkspaceImageResult, __MetadataBearer {} /** - *

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 - * + *

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 Sever 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.

    + *

    Only Windows 10, Windows Sever 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.

    + *

    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.

    + *

    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.

    *
    • *
* diff --git a/clients/client-workspaces/src/commands/DeleteClientBrandingCommand.ts b/clients/client-workspaces/src/commands/DeleteClientBrandingCommand.ts new file mode 100644 index 000000000000..43a7f435796c --- /dev/null +++ b/clients/client-workspaces/src/commands/DeleteClientBrandingCommand.ts @@ -0,0 +1,100 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { DeleteClientBrandingRequest, DeleteClientBrandingResult } from "../models/models_0"; +import { + deserializeAws_json1_1DeleteClientBrandingCommand, + serializeAws_json1_1DeleteClientBrandingCommand, +} from "../protocols/Aws_json1_1"; +import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesClientResolvedConfig } from "../WorkSpacesClient"; + +export interface DeleteClientBrandingCommandInput extends DeleteClientBrandingRequest {} +export interface DeleteClientBrandingCommandOutput extends DeleteClientBrandingResult, __MetadataBearer {} + +/** + *

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.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DeleteClientBrandingCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DeleteClientBrandingCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DeleteClientBrandingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClientBrandingCommandInput} for command's `input` shape. + * @see {@link DeleteClientBrandingCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for WorkSpacesClient's `config` shape. + * + */ +export class DeleteClientBrandingCommand extends $Command< + DeleteClientBrandingCommandInput, + DeleteClientBrandingCommandOutput, + WorkSpacesClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteClientBrandingCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: WorkSpacesClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "WorkSpacesClient"; + const commandName = "DeleteClientBrandingCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: DeleteClientBrandingRequest.filterSensitiveLog, + outputFilterSensitiveLog: DeleteClientBrandingResult.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: DeleteClientBrandingCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_json1_1DeleteClientBrandingCommand(input, context); + } + + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return deserializeAws_json1_1DeleteClientBrandingCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-workspaces/src/commands/DeleteConnectionAliasCommand.ts b/clients/client-workspaces/src/commands/DeleteConnectionAliasCommand.ts index db3598b877a3..7eb2e1ddfb65 100644 --- a/clients/client-workspaces/src/commands/DeleteConnectionAliasCommand.ts +++ b/clients/client-workspaces/src/commands/DeleteConnectionAliasCommand.ts @@ -23,21 +23,19 @@ export interface DeleteConnectionAliasCommandOutput extends DeleteConnectionAlia /** *

Deletes the specified connection alias. For more information, see - * Cross-Region Redirection for Amazon WorkSpaces.

- * + * 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.

+ * 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 + *

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.

* * @example diff --git a/clients/client-workspaces/src/commands/DeregisterWorkspaceDirectoryCommand.ts b/clients/client-workspaces/src/commands/DeregisterWorkspaceDirectoryCommand.ts index f2c7b588fbd4..c9a95824bbf9 100644 --- a/clients/client-workspaces/src/commands/DeregisterWorkspaceDirectoryCommand.ts +++ b/clients/client-workspaces/src/commands/DeregisterWorkspaceDirectoryCommand.ts @@ -24,22 +24,19 @@ export interface DeregisterWorkspaceDirectoryCommandOutput __MetadataBearer {} /** - *

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.

- * + *

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.

+ *

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.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-workspaces/src/commands/DescribeClientBrandingCommand.ts b/clients/client-workspaces/src/commands/DescribeClientBrandingCommand.ts new file mode 100644 index 000000000000..2d39eb9491ba --- /dev/null +++ b/clients/client-workspaces/src/commands/DescribeClientBrandingCommand.ts @@ -0,0 +1,102 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { DescribeClientBrandingRequest, DescribeClientBrandingResult } from "../models/models_0"; +import { + deserializeAws_json1_1DescribeClientBrandingCommand, + serializeAws_json1_1DescribeClientBrandingCommand, +} from "../protocols/Aws_json1_1"; +import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesClientResolvedConfig } from "../WorkSpacesClient"; + +export interface DescribeClientBrandingCommandInput extends DescribeClientBrandingRequest {} +export interface DescribeClientBrandingCommandOutput extends DescribeClientBrandingResult, __MetadataBearer {} + +/** + *

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.

+ * + * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeClientBrandingCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeClientBrandingCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeClientBrandingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClientBrandingCommandInput} for command's `input` shape. + * @see {@link DescribeClientBrandingCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for WorkSpacesClient's `config` shape. + * + */ +export class DescribeClientBrandingCommand extends $Command< + DescribeClientBrandingCommandInput, + DescribeClientBrandingCommandOutput, + WorkSpacesClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeClientBrandingCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: WorkSpacesClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "WorkSpacesClient"; + const commandName = "DescribeClientBrandingCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: DescribeClientBrandingRequest.filterSensitiveLog, + outputFilterSensitiveLog: DescribeClientBrandingResult.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: DescribeClientBrandingCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_json1_1DescribeClientBrandingCommand(input, context); + } + + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return deserializeAws_json1_1DescribeClientBrandingCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-workspaces/src/commands/DescribeConnectionAliasPermissionsCommand.ts b/clients/client-workspaces/src/commands/DescribeConnectionAliasPermissionsCommand.ts index 2f05ef3869fc..1c81cc5717cb 100644 --- a/clients/client-workspaces/src/commands/DescribeConnectionAliasPermissionsCommand.ts +++ b/clients/client-workspaces/src/commands/DescribeConnectionAliasPermissionsCommand.ts @@ -27,9 +27,10 @@ export interface DescribeConnectionAliasPermissionsCommandOutput __MetadataBearer {} /** - *

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.

+ *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-workspaces/src/commands/DescribeConnectionAliasesCommand.ts b/clients/client-workspaces/src/commands/DescribeConnectionAliasesCommand.ts index 4a658fa3fa63..dbe1f911f8d3 100644 --- a/clients/client-workspaces/src/commands/DescribeConnectionAliasesCommand.ts +++ b/clients/client-workspaces/src/commands/DescribeConnectionAliasesCommand.ts @@ -22,9 +22,9 @@ export interface DescribeConnectionAliasesCommandInput extends DescribeConnectio export interface DescribeConnectionAliasesCommandOutput extends DescribeConnectionAliasesResult, __MetadataBearer {} /** - *

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see - * - * Cross-Region Redirection for Amazon WorkSpaces.

+ *

Retrieves a list that describes the connection aliases used for cross-Region + * redirection. For more information, see Cross-Region + * Redirection for Amazon WorkSpaces.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-workspaces/src/commands/DescribeWorkspaceDirectoriesCommand.ts b/clients/client-workspaces/src/commands/DescribeWorkspaceDirectoriesCommand.ts index f42f8527e447..01c48c0a994b 100644 --- a/clients/client-workspaces/src/commands/DescribeWorkspaceDirectoriesCommand.ts +++ b/clients/client-workspaces/src/commands/DescribeWorkspaceDirectoriesCommand.ts @@ -24,8 +24,7 @@ export interface DescribeWorkspaceDirectoriesCommandOutput __MetadataBearer {} /** - *

Describes the available directories that are registered with - * Amazon WorkSpaces.

+ *

Describes the available directories that are registered with Amazon WorkSpaces.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-workspaces/src/commands/DescribeWorkspaceImagePermissionsCommand.ts b/clients/client-workspaces/src/commands/DescribeWorkspaceImagePermissionsCommand.ts index 15438158cce2..7c18820b7411 100644 --- a/clients/client-workspaces/src/commands/DescribeWorkspaceImagePermissionsCommand.ts +++ b/clients/client-workspaces/src/commands/DescribeWorkspaceImagePermissionsCommand.ts @@ -24,8 +24,7 @@ export interface DescribeWorkspaceImagePermissionsCommandOutput __MetadataBearer {} /** - *

Describes the permissions that the owner of an image has granted to other - * Amazon Web Services accounts for an image.

+ *

Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-workspaces/src/commands/DisassociateConnectionAliasCommand.ts b/clients/client-workspaces/src/commands/DisassociateConnectionAliasCommand.ts index a9e72bebd212..d893fc3a6b4f 100644 --- a/clients/client-workspaces/src/commands/DisassociateConnectionAliasCommand.ts +++ b/clients/client-workspaces/src/commands/DisassociateConnectionAliasCommand.ts @@ -22,14 +22,14 @@ export interface DisassociateConnectionAliasCommandInput extends DisassociateCon export interface DisassociateConnectionAliasCommandOutput extends DisassociateConnectionAliasResult, __MetadataBearer {} /** - *

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.

- * + *

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.

+ * DescribeConnectionAliases to make sure that the current state of the + * connection alias is CREATED.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-workspaces/src/commands/ImportClientBrandingCommand.ts b/clients/client-workspaces/src/commands/ImportClientBrandingCommand.ts new file mode 100644 index 000000000000..470004bff3ca --- /dev/null +++ b/clients/client-workspaces/src/commands/ImportClientBrandingCommand.ts @@ -0,0 +1,122 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { ImportClientBrandingRequest, ImportClientBrandingResult } from "../models/models_0"; +import { + deserializeAws_json1_1ImportClientBrandingCommand, + serializeAws_json1_1ImportClientBrandingCommand, +} from "../protocols/Aws_json1_1"; +import { ServiceInputTypes, ServiceOutputTypes, WorkSpacesClientResolvedConfig } from "../WorkSpacesClient"; + +export interface ImportClientBrandingCommandInput extends ImportClientBrandingRequest {} +export interface ImportClientBrandingCommandOutput extends ImportClientBrandingResult, __MetadataBearer {} + +/** + *

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 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 different 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.

    + *
    • + *
+ * + * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, ImportClientBrandingCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, ImportClientBrandingCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new ImportClientBrandingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportClientBrandingCommandInput} for command's `input` shape. + * @see {@link ImportClientBrandingCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for WorkSpacesClient's `config` shape. + * + */ +export class ImportClientBrandingCommand extends $Command< + ImportClientBrandingCommandInput, + ImportClientBrandingCommandOutput, + WorkSpacesClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ImportClientBrandingCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: WorkSpacesClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "WorkSpacesClient"; + const commandName = "ImportClientBrandingCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: ImportClientBrandingRequest.filterSensitiveLog, + outputFilterSensitiveLog: ImportClientBrandingResult.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: ImportClientBrandingCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_json1_1ImportClientBrandingCommand(input, context); + } + + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return deserializeAws_json1_1ImportClientBrandingCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-workspaces/src/commands/ImportWorkspaceImageCommand.ts b/clients/client-workspaces/src/commands/ImportWorkspaceImageCommand.ts index d254141ff9b7..40f565dfbe57 100644 --- a/clients/client-workspaces/src/commands/ImportWorkspaceImageCommand.ts +++ b/clients/client-workspaces/src/commands/ImportWorkspaceImageCommand.ts @@ -23,10 +23,9 @@ export interface ImportWorkspaceImageCommandOutput extends ImportWorkspaceImageR /** *

Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon - * WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your - * Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see - * - * Bring Your Own Windows Desktop Licenses.

+ * WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL + * images, see Bring Your Own Windows + * Desktop Licenses.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-workspaces/src/commands/ListAvailableManagementCidrRangesCommand.ts b/clients/client-workspaces/src/commands/ListAvailableManagementCidrRangesCommand.ts index 1a9715ec3c5c..a5921a96f1dc 100644 --- a/clients/client-workspaces/src/commands/ListAvailableManagementCidrRangesCommand.ts +++ b/clients/client-workspaces/src/commands/ListAvailableManagementCidrRangesCommand.ts @@ -26,10 +26,9 @@ export interface ListAvailableManagementCidrRangesCommandOutput /** *

Retrieves a list of IP address ranges, specified 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 Amazon Web Services accounts that are enabled for BYOL. If your account - * isn't enabled for BYOL, you'll receive an AccessDeniedException error.

- * + *

This operation can be run only by Amazon Web Services 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.

diff --git a/clients/client-workspaces/src/commands/MigrateWorkspaceCommand.ts b/clients/client-workspaces/src/commands/MigrateWorkspaceCommand.ts index 5e07a736c5dd..f9e94b1e4e39 100644 --- a/clients/client-workspaces/src/commands/MigrateWorkspaceCommand.ts +++ b/clients/client-workspaces/src/commands/MigrateWorkspaceCommand.ts @@ -22,15 +22,17 @@ export interface MigrateWorkspaceCommandInput extends MigrateWorkspaceRequest {} export interface MigrateWorkspaceCommandOutput extends MigrateWorkspaceResult, __MetadataBearer {} /** - *

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 profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ - * folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.

- * - *

For available migration scenarios, details about what happens during migration, and best practices, see - * Migrate a WorkSpace.

+ *

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 profile + * folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new + * D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in + * the old user profile are moved to the new user profile.

+ *

For available migration scenarios, details about what happens during migration, and best + * practices, see Migrate a + * WorkSpace.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-workspaces/src/commands/ModifyWorkspacePropertiesCommand.ts b/clients/client-workspaces/src/commands/ModifyWorkspacePropertiesCommand.ts index ca1260de8f08..3b746dd95c8f 100644 --- a/clients/client-workspaces/src/commands/ModifyWorkspacePropertiesCommand.ts +++ b/clients/client-workspaces/src/commands/ModifyWorkspacePropertiesCommand.ts @@ -22,10 +22,8 @@ export interface ModifyWorkspacePropertiesCommandInput extends ModifyWorkspacePr export interface ModifyWorkspacePropertiesCommandOutput extends ModifyWorkspacePropertiesResult, __MetadataBearer {} /** - *

Modifies the specified WorkSpace properties. For important information about how - * to modify the size of the root and user volumes, see - * - * Modify a WorkSpace. + *

Modifies the specified WorkSpace properties. For important information about how to + * modify the size of the root and user volumes, see Modify a WorkSpace. *

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-workspaces/src/commands/RebuildWorkspacesCommand.ts b/clients/client-workspaces/src/commands/RebuildWorkspacesCommand.ts index 6799352f7d26..e7f30c678cfc 100644 --- a/clients/client-workspaces/src/commands/RebuildWorkspacesCommand.ts +++ b/clients/client-workspaces/src/commands/RebuildWorkspacesCommand.ts @@ -24,7 +24,8 @@ export interface RebuildWorkspacesCommandOutput extends RebuildWorkspacesResult, /** *

Rebuilds the specified WorkSpace.

*

You cannot rebuild a WorkSpace unless its state is AVAILABLE, - * ERROR, UNHEALTHY, STOPPED, or REBOOTING.

+ * 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.

diff --git a/clients/client-workspaces/src/commands/RegisterWorkspaceDirectoryCommand.ts b/clients/client-workspaces/src/commands/RegisterWorkspaceDirectoryCommand.ts index 80a437565002..24b5faa1725d 100644 --- a/clients/client-workspaces/src/commands/RegisterWorkspaceDirectoryCommand.ts +++ b/clients/client-workspaces/src/commands/RegisterWorkspaceDirectoryCommand.ts @@ -22,10 +22,10 @@ export interface RegisterWorkspaceDirectoryCommandInput extends RegisterWorkspac export interface RegisterWorkspaceDirectoryCommandOutput extends RegisterWorkspaceDirectoryResult, __MetadataBearer {} /** - *

Registers the specified directory. This operation is asynchronous - * and returns before the WorkSpace directory is registered. If this is the first 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 + *

Registers the specified directory. This operation is asynchronous and returns before the + * WorkSpace directory is registered. If this is the first 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.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-workspaces/src/commands/TerminateWorkspacesCommand.ts b/clients/client-workspaces/src/commands/TerminateWorkspacesCommand.ts index d1070cfa8ca8..eedbf9065955 100644 --- a/clients/client-workspaces/src/commands/TerminateWorkspacesCommand.ts +++ b/clients/client-workspaces/src/commands/TerminateWorkspacesCommand.ts @@ -23,34 +23,29 @@ export interface TerminateWorkspacesCommandOutput extends TerminateWorkspacesRes /** *

Terminates the specified WorkSpaces.

- * * - *

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is - * destroyed. If you need to archive any user data, contact Amazon Web Services Support before + *

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data + * is destroyed. If you need to archive any user data, contact Amazon Web Services Support before * terminating the WorkSpace.

* - * *

You can terminate a WorkSpace that is in any state except SUSPENDED.

*

This operation is asynchronous and returns before the WorkSpaces have been completely * terminated. After a WorkSpace is terminated, the TERMINATED state is returned * only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely * returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using - * + * * DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has * been successfully terminated.

- * * - *

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.

+ *

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.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-workspaces/src/commands/UpdateConnectionAliasPermissionCommand.ts b/clients/client-workspaces/src/commands/UpdateConnectionAliasPermissionCommand.ts index c7dad425dd45..eb6d97eef673 100644 --- a/clients/client-workspaces/src/commands/UpdateConnectionAliasPermissionCommand.ts +++ b/clients/client-workspaces/src/commands/UpdateConnectionAliasPermissionCommand.ts @@ -24,23 +24,25 @@ export interface UpdateConnectionAliasPermissionCommandOutput __MetadataBearer {} /** - *

Shares or unshares a connection alias with one account by specifying whether that account has permission to - * associate the connection alias with a directory. If the association permission is granted, the connection alias - * is shared with that account. If the association permission is revoked, the connection alias is unshared with the - * account. For more information, see - * Cross-Region Redirection for Amazon WorkSpaces.

- * + *

Shares or unshares a connection alias with one account by specifying whether that + * account has permission to associate the connection alias with a directory. If the + * association permission is granted, the connection alias is shared with that account. If the + * association permission is revoked, the connection alias is unshared with the account. For + * more information, see Cross-Region + * Redirection for Amazon WorkSpaces.

* *
    *
  • *

    Before performing this operation, call - * DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

    + * DescribeConnectionAliases to make sure that the current state of the + * connection alias is CREATED.

    *
    • *
  • - *

    To delete a connection alias that has been shared, the shared account must first disassociate the - * connection alias from any directories it has been associated with. Then you must unshare the connection - * alias from the account it has been shared with. You can delete a connection alias only after it is no - * longer shared with any accounts or associated with any directories.

    + *

    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.

    *
    • *
* diff --git a/clients/client-workspaces/src/commands/UpdateWorkspaceImagePermissionCommand.ts b/clients/client-workspaces/src/commands/UpdateWorkspaceImagePermissionCommand.ts index 353dbfbbfefb..d76719d09970 100644 --- a/clients/client-workspaces/src/commands/UpdateWorkspaceImagePermissionCommand.ts +++ b/clients/client-workspaces/src/commands/UpdateWorkspaceImagePermissionCommand.ts @@ -24,29 +24,26 @@ export interface UpdateWorkspaceImagePermissionCommandOutput __MetadataBearer {} /** - *

Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has - * permission to copy the image. If the copy image permission is granted, the image is shared with that account. - * If the copy image permission is revoked, the image is unshared with the account.

- * - *

After an image has been shared, the recipient account can copy the image to other Regions as needed.

- * + *

Shares or unshares an image with one account in the same Amazon Web Services Region by + * specifying whether that account has permission to copy the image. If the copy image + * permission is granted, the image is shared with that account. If the copy image permission + * is revoked, the image is unshared with the account.

+ *

After an image has been shared, the recipient account can copy the image to other + * Regions as needed.

*

In the China (Ningxia) Region, you can copy images only within the same Region.

- * *

In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

- * - *

For more information about sharing images, see - * - * Share or Unshare a Custom WorkSpaces Image.

- * + *

For more information about sharing images, see Share or Unshare a Custom + * WorkSpaces Image.

* *
    *
  • - *

    To delete an image that has been shared, you must unshare the image before you delete it.

    + *

    To delete an image that has been shared, you must unshare the image before you + * delete it.

    *
    • *
  • - *

    Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at - * this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in - * Amazon Web Services GovCloud (US), contact Amazon Web Services Support.

    + *

    Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts + * isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images + * across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.

    *
    • *
* diff --git a/clients/client-workspaces/src/commands/index.ts b/clients/client-workspaces/src/commands/index.ts index ad66a65c5f2c..df48b147a037 100644 --- a/clients/client-workspaces/src/commands/index.ts +++ b/clients/client-workspaces/src/commands/index.ts @@ -9,6 +9,7 @@ export * from "./CreateTagsCommand"; export * from "./CreateUpdatedWorkspaceImageCommand"; export * from "./CreateWorkspaceBundleCommand"; export * from "./CreateWorkspacesCommand"; +export * from "./DeleteClientBrandingCommand"; export * from "./DeleteConnectClientAddInCommand"; export * from "./DeleteConnectionAliasCommand"; export * from "./DeleteIpGroupCommand"; @@ -18,6 +19,7 @@ export * from "./DeleteWorkspaceImageCommand"; export * from "./DeregisterWorkspaceDirectoryCommand"; export * from "./DescribeAccountCommand"; export * from "./DescribeAccountModificationsCommand"; +export * from "./DescribeClientBrandingCommand"; export * from "./DescribeClientPropertiesCommand"; export * from "./DescribeConnectClientAddInsCommand"; export * from "./DescribeConnectionAliasPermissionsCommand"; @@ -33,6 +35,7 @@ export * from "./DescribeWorkspacesCommand"; export * from "./DescribeWorkspacesConnectionStatusCommand"; export * from "./DisassociateConnectionAliasCommand"; export * from "./DisassociateIpGroupsCommand"; +export * from "./ImportClientBrandingCommand"; export * from "./ImportWorkspaceImageCommand"; export * from "./ListAvailableManagementCidrRangesCommand"; export * from "./MigrateWorkspaceCommand"; diff --git a/clients/client-workspaces/src/models/models_0.ts b/clients/client-workspaces/src/models/models_0.ts index 8dc36355f1eb..e1f76c6c7565 100644 --- a/clients/client-workspaces/src/models/models_0.ts +++ b/clients/client-workspaces/src/models/models_0.ts @@ -113,8 +113,8 @@ export namespace AssociateConnectionAliasRequest { export interface AssociateConnectionAliasResult { /** - *

The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when - * you're configuring your DNS routing policies.

+ *

The identifier of the connection alias association. You use the connection identifier in + * the DNS TXT record when you're configuring your DNS routing policies.

*/ ConnectionIdentifier?: string; } @@ -477,6 +477,15 @@ export namespace WorkspaceBundle { }); } +export enum ClientDeviceType { + DEVICE_TYPE_ANDROID = "DeviceTypeAndroid", + DEVICE_TYPE_IOS = "DeviceTypeIos", + DEVICE_TYPE_LINUX = "DeviceTypeLinux", + DEVICE_TYPE_OSX = "DeviceTypeOsx", + DEVICE_TYPE_WEB = "DeviceTypeWeb", + DEVICE_TYPE_WINDOWS = "DeviceTypeWindows", +} + export enum ReconnectEnum { DISABLED = "DISABLED", ENABLED = "ENABLED", @@ -562,9 +571,9 @@ export namespace ConnectClientAddIn { } /** - *

Describes a connection alias association that is used for cross-Region redirection. For more information, see - * - * Cross-Region Redirection for Amazon WorkSpaces.

+ *

Describes a connection alias association that is used for cross-Region redirection. For + * more information, see Cross-Region + * Redirection for Amazon WorkSpaces.

*/ export interface ConnectionAliasAssociation { /** @@ -573,7 +582,8 @@ export interface ConnectionAliasAssociation { AssociationStatus?: AssociationStatus | string; /** - *

The identifier of the Amazon Web Services account that associated the connection alias with a directory.

+ *

The identifier of the Amazon Web Services account that associated the connection alias + * with a directory.

*/ AssociatedAccountId?: string; @@ -583,8 +593,8 @@ export interface ConnectionAliasAssociation { ResourceId?: string; /** - *

The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when - * you're configuring your DNS routing policies.

+ *

The identifier of the connection alias association. You use the connection identifier in + * the DNS TXT record when you're configuring your DNS routing policies.

*/ ConnectionIdentifier?: string; } @@ -605,14 +615,15 @@ export enum ConnectionAliasState { } /** - *

Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, - * see - * Cross-Region Redirection for Amazon WorkSpaces.

+ *

Describes a connection alias. Connection aliases are used for cross-Region redirection. + * For more information, see Cross-Region + * Redirection for Amazon WorkSpaces.

*/ export interface ConnectionAlias { /** - *

The connection string specified for the connection alias. The connection string must be in the form of - * a fully qualified domain name (FQDN), such as www.example.com.

+ *

The connection string specified for the connection alias. The connection string must be + * in the form of a fully qualified domain name (FQDN), such as + * www.example.com.

*/ ConnectionString?: string; @@ -647,18 +658,20 @@ export namespace ConnectionAlias { } /** - *

Describes the permissions for a connection alias. Connection aliases are used for cross-Region redirection. - * For more information, see - * Cross-Region Redirection for Amazon WorkSpaces.

+ *

Describes the permissions for a connection alias. Connection aliases are used for + * cross-Region redirection. For more information, see Cross-Region + * Redirection for Amazon WorkSpaces.

*/ export interface ConnectionAliasPermission { /** - *

The identifier of the Amazon Web Services account that the connection alias is shared with.

+ *

The identifier of the Amazon Web Services account that the connection alias is shared + * with.

*/ SharedAccountId: string | undefined; /** - *

Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.

+ *

Indicates whether the specified Amazon Web Services account is allowed to associate the + * connection alias with a directory.

*/ AllowAssociation: boolean | undefined; } @@ -861,12 +874,12 @@ export class ResourceCreationFailedException extends __BaseException { export interface CreateConnectionAliasRequest { /** - *

A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com.

- * + *

A connection string in the form of a fully qualified domain name (FQDN), such as + * www.example.com.

* - *

After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same - * connection string with a different account, even if you delete all instances of it from the original account. The - * connection string is globally reserved for your account.

+ *

After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different + * account, even if you delete all instances of it from the original account. The + * connection string is globally reserved for your account.

* */ ConnectionString: string | undefined; @@ -952,7 +965,8 @@ export namespace CreateIpGroupResult { export interface CreateTagsRequest { /** *

The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, - * registered directories, images, custom bundles, IP access control groups, and connection aliases.

+ * registered directories, images, custom bundles, IP access control groups, and connection + * aliases.

*/ ResourceId: string | undefined; @@ -1000,10 +1014,10 @@ export interface CreateUpdatedWorkspaceImageRequest { /** *

The tags that you want to add to the new updated WorkSpace image.

- * * *

To add tags at the same time when you're creating the updated image, you must create - * an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.

+ * an IAM policy that grants your IAM user permissions to use + * workspaces:CreateTags.

* */ Tags?: Tag[]; @@ -1117,19 +1131,22 @@ export interface WorkspaceProperties { RunningMode?: RunningMode | string; /** - *

The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

+ *

The time after a user logs off when WorkSpaces are automatically stopped. Configured in + * 60-minute intervals.

*/ RunningModeAutoStopTimeoutInMinutes?: number; /** - *

The size of the root volume. For important information about how to modify the size of the root and user volumes, see - * Modify a WorkSpace.

+ *

The size of the root volume. For important information about how to modify the size of + * the root and user volumes, see Modify a + * WorkSpace.

*/ RootVolumeSizeGib?: number; /** - *

The size of the user storage. For important information about how to modify the size of the root and user volumes, see - * Modify a WorkSpace.

+ *

The size of the user storage. For important information about how to modify the size of + * the root and user volumes, see Modify a + * WorkSpace.

*/ UserVolumeSizeGib?: number; @@ -1154,14 +1171,12 @@ export namespace WorkspaceProperties { */ export interface WorkspaceRequest { /** - *

The identifier of the Directory Service directory for the WorkSpace. You can use - * DescribeWorkspaceDirectories to list the available directories.

+ *

The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

*/ DirectoryId: string | undefined; /** - *

The user name of the user for the WorkSpace. This user name must exist in the Directory Service - * directory for the WorkSpace.

+ *

The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.

*/ UserName: string | undefined; @@ -1333,14 +1348,13 @@ export interface Workspace { /** *

The operational state of the WorkSpace.

- * * - *

After a WorkSpace is terminated, the TERMINATED state is returned - * only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely + *

After a WorkSpace is terminated, the TERMINATED state is returned only + * briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely * returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using - * - * DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has - * been successfully terminated.

+ * + * DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace + * has been successfully terminated.

* */ State?: WorkspaceState | string; @@ -1367,9 +1381,9 @@ export interface Workspace { ErrorCode?: string; /** - *

The name of the WorkSpace, as seen by the operating system. The format of this name varies. - * For more information, see - * Launch a WorkSpace.

+ *

The name of the WorkSpace, as seen by the operating system. The format of this name + * varies. For more information, see Launch a + * WorkSpace.

*/ ComputerName?: string; @@ -1438,7 +1452,155 @@ export enum DedicatedTenancySupportEnum { } /** - *

Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

+ *

Returns default client branding attributes that were imported. These attributes display + * on the client login screen.

+ * + *

Client branding attributes are public facing. Ensure that you don't include sensitive + * information.

+ * + */ +export interface DefaultClientBrandingAttributes { + /** + *

The logo URL. This is the link where users can download the logo image. The only + * supported image format is .png.

+ */ + LogoUrl?: string; + + /** + *

The support email. The company's customer support email address.

+ * + *
    + *
  • + *

    In each platform type, the SupportEmail and + * SupportLink parameters are mutually exclusive. You can specify one + * parameter for each platform type, but not both.

    + *
    • + *
  • + *

    The default email is workspaces-feedback@amazon.com.

    + *
    • + *
+ * + */ + SupportEmail?: string; + + /** + *

The support link. The link for the company's customer support page for their + * WorkSpace.

+ * + *
    + *
  • + *

    In each platform type, the SupportEmail and + * SupportLink parameters are mutually exclusive.You can specify one + * parameter for each platform type, but not both.

    + *
    • + *
  • + *

    The default support link is workspaces-feedback@amazon.com.

    + *
    • + *
+ * + */ + SupportLink?: string; + + /** + *

The forgotten password link. This is the web address that users can go to if they forget + * the password for their WorkSpace.

+ */ + ForgotPasswordLink?: string; + + /** + *

The login message. Specified as a key value pair, in which the key is a locale and the + * value is the localized message for that locale. The only key supported is + * en_US.

+ */ + LoginMessage?: { [key: string]: string }; +} + +export namespace DefaultClientBrandingAttributes { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DefaultClientBrandingAttributes): any => ({ + ...obj, + }); +} + +/** + *

The default client branding attributes to be imported. These attributes display on the + * client login screen.

+ * + *

Client branding attributes are public facing. Ensure that you do not include + * sensitive information.

+ * + */ +export interface DefaultImportClientBrandingAttributes { + /** + *

The logo. This is the link where users can download the logo image. The only image + * format accepted is .png.

+ */ + Logo?: Uint8Array; + + /** + *

The support email. The company's customer support email address.

+ * + *
    + *
  • + *

    In each platform type, the SupportEmail and + * SupportLink parameters are mutually exclusive. You can specify one + * parameter for each platform type, but not both.

    + *
    • + *
  • + *

    The default email is workspaces-feedback@amazon.com.

    + *
    • + *
+ * + */ + SupportEmail?: string; + + /** + *

The support link. The link for the company's customer support page for their + * WorkSpace.

+ * + *
    + *
  • + *

    In each platform type, the SupportEmail and + * SupportLink parameters are mutually exclusive. You can specify one + * parameter for each platform type, but not both.

    + *
    • + *
  • + *

    The default support link is workspaces-feedback@amazon.com.

    + *
    • + *
+ * + */ + SupportLink?: string; + + /** + *

The forgotten password link. This is the web address that users can go to if they forget + * the password for their WorkSpace.

+ */ + ForgotPasswordLink?: string; + + /** + *

The login message. Specified as a key value pair, in which the key is a locale and the + * value is the localized message for that locale. The only key supported is + * en_US.

+ */ + LoginMessage?: { [key: string]: string }; +} + +export namespace DefaultImportClientBrandingAttributes { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DefaultImportClientBrandingAttributes): any => ({ + ...obj, + }); +} + +/** + *

Describes the default values that are used to create WorkSpaces. For more information, + * see Update Directory + * Details for Your WorkSpaces.

*/ export interface DefaultWorkspaceCreationProperties { /** @@ -1447,14 +1609,15 @@ export interface DefaultWorkspaceCreationProperties { EnableWorkDocs?: boolean; /** - *

Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. - * If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an - * internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address - * Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public - * subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting - * applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, - * see - * Configure a VPC for Amazon WorkSpaces.

+ *

Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in + * this directory by default. If enabled, the Elastic public IP address allows outbound + * internet access from your WorkSpaces when you’re using an internet gateway in the Amazon + * VPC in which your WorkSpaces are located. If you're using a Network Address Translation + * (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in + * public subnets and you manually assign them Elastic IP addresses, you should disable this + * setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces + * that you rebuild. For more information, see Configure a VPC for + * Amazon WorkSpaces.

*/ EnableInternetAccess?: boolean; @@ -1464,10 +1627,9 @@ export interface DefaultWorkspaceCreationProperties { DefaultOu?: string; /** - *

The identifier of the default security group to apply to WorkSpaces when they are created. - * For more information, see - * - * Security Groups for Your WorkSpaces.

+ *

The identifier of the default security group to apply to WorkSpaces when they are + * created. For more information, see Security + * Groups for Your WorkSpaces.

*/ CustomSecurityGroupId?: string; @@ -1493,6 +1655,39 @@ export namespace DefaultWorkspaceCreationProperties { }); } +export interface DeleteClientBrandingRequest { + /** + *

The directory identifier of the WorkSpace for which you want to delete client + * branding.

+ */ + ResourceId: string | undefined; + + /** + *

The device type for which you want to delete client branding.

+ */ + Platforms: (ClientDeviceType | string)[] | undefined; +} + +export namespace DeleteClientBrandingRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteClientBrandingRequest): any => ({ + ...obj, + }); +} + +export interface DeleteClientBrandingResult {} + +export namespace DeleteClientBrandingResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteClientBrandingResult): any => ({ + ...obj, + }); +} + export interface DeleteConnectClientAddInRequest { /** *

The identifier of the client add-in to delete.

@@ -1582,7 +1777,8 @@ export namespace DeleteIpGroupResult { export interface DeleteTagsRequest { /** *

The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, - * registered directories, images, custom bundles, IP access control groups, and connection aliases.

+ * registered directories, images, custom bundles, IP access control groups, and connection + * aliases.

*/ ResourceId: string | undefined; @@ -1668,9 +1864,9 @@ export namespace DeleteWorkspaceImageResult { export interface DeregisterWorkspaceDirectoryRequest { /** - *

The identifier of the directory. If any WorkSpaces are registered to this directory, you must - * remove them before you deregister the directory, or you will receive an OperationNotSupportedException - * error.

+ *

The identifier of the directory. If any WorkSpaces are registered to this directory, you + * must remove them before you deregister the directory, or you will receive an + * OperationNotSupportedException error.

*/ DirectoryId: string | undefined; } @@ -1755,8 +1951,8 @@ export interface DescribeAccountModificationsResult { AccountModifications?: AccountModification[]; /** - *

The token to use to retrieve the next page of results. This value is null when there - * are no more results to return.

+ *

The token to use to retrieve the next page of results. This value is null when there are + * no more results to return.

*/ NextToken?: string; } @@ -1770,6 +1966,158 @@ export namespace DescribeAccountModificationsResult { }); } +export interface DescribeClientBrandingRequest { + /** + *

The directory identifier of the WorkSpace for which you want to view client branding + * information.

+ */ + ResourceId: string | undefined; +} + +export namespace DescribeClientBrandingRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeClientBrandingRequest): any => ({ + ...obj, + }); +} + +/** + *

The client branding attributes for iOS device types. These attributes are displayed on + * the iOS client login screen only.

+ * + *

Client branding attributes are public facing. Ensure you do not include sensitive + * information.

+ * + */ +export interface IosClientBrandingAttributes { + /** + *

The logo. This is the link where users can download the logo image. This is the + * standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal + * to one point.

+ */ + LogoUrl?: string; + + /** + *

The @2x version of the logo. This is the higher resolution display that offers a scale + * factor of 2.0 (or @2x).

+ * + *

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface + * Guidelines.

+ * + */ + Logo2xUrl?: string; + + /** + *

The @3x version of the logo. This is the higher resolution display that offers a scale + * factor of 3.0 (or @3x).

+ * + *

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface + * Guidelines.

+ * + */ + Logo3xUrl?: string; + + /** + *

The support email. The company's customer support email address.

+ * + *
    + *
  • + *

    In each platform type, the SupportEmail and + * SupportLink parameters are mutually exclusive. You can specify one + * parameter for each platform type, but not both.

    + *
    • + *
  • + *

    The default email is workspaces-feedback@amazon.com.

    + *
    • + *
+ * + */ + SupportEmail?: string; + + /** + *

The support link. The link for the company's customer support page for their + * WorkSpace.

+ * + *
    + *
  • + *

    In each platform type, the SupportEmail and + * SupportLink parameters are mutually exclusive. You can specify one + * parameter for each platform type, but not both.

    + *
    • + *
  • + *

    The default support link is workspaces-feedback@amazon.com.

    + *
    • + *
+ * + */ + SupportLink?: string; + + /** + *

The forgotten password link. This is the web address that users can go to if they forget + * the password for their WorkSpace.

+ */ + ForgotPasswordLink?: string; + + /** + *

The login message. Specified as a key value pair, in which the key is a locale and the + * value is the localized message for that locale. The only key supported is + * en_US.

+ */ + LoginMessage?: { [key: string]: string }; +} + +export namespace IosClientBrandingAttributes { + /** + * @internal + */ + export const filterSensitiveLog = (obj: IosClientBrandingAttributes): any => ({ + ...obj, + }); +} + +export interface DescribeClientBrandingResult { + /** + *

The branding information for Windows devices.

+ */ + DeviceTypeWindows?: DefaultClientBrandingAttributes; + + /** + *

The branding information for macOS devices.

+ */ + DeviceTypeOsx?: DefaultClientBrandingAttributes; + + /** + *

The branding information for Android devices.

+ */ + DeviceTypeAndroid?: DefaultClientBrandingAttributes; + + /** + *

The branding information for iOS devices.

+ */ + DeviceTypeIos?: IosClientBrandingAttributes; + + /** + *

The branding information for Linux devices.

+ */ + DeviceTypeLinux?: DefaultClientBrandingAttributes; + + /** + *

The branding information for Web access.

+ */ + DeviceTypeWeb?: DefaultClientBrandingAttributes; +} + +export namespace DescribeClientBrandingResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeClientBrandingResult): any => ({ + ...obj, + }); +} + export interface DescribeClientPropertiesRequest { /** *

The resource identifier, in the form of directory IDs.

@@ -1868,8 +2216,8 @@ export interface DescribeConnectionAliasesRequest { Limit?: number; /** - *

If you received a NextToken from a previous call that was paginated, provide this token to receive the - * next set of results.

+ *

If you received a NextToken from a previous call that was paginated, + * provide this token to receive the next set of results.

*/ NextToken?: string; } @@ -1890,7 +2238,8 @@ export interface DescribeConnectionAliasesResult { ConnectionAliases?: ConnectionAlias[]; /** - *

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

+ *

The token to use to retrieve the next page of results. This value is null when there are + * no more results to return.

*/ NextToken?: string; } @@ -1911,8 +2260,8 @@ export interface DescribeConnectionAliasPermissionsRequest { AliasId: string | undefined; /** - *

If you received a NextToken from a previous call that was paginated, provide this token to receive the - * next set of results.

+ *

If you received a NextToken from a previous call that was paginated, + * provide this token to receive the next set of results.

*/ NextToken?: string; @@ -1943,7 +2292,8 @@ export interface DescribeConnectionAliasPermissionsResult { ConnectionAliasPermissions?: ConnectionAliasPermission[]; /** - *

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

+ *

The token to use to retrieve the next page of results. This value is null when there are + * no more results to return.

*/ NextToken?: string; } @@ -2025,7 +2375,8 @@ export interface DescribeIpGroupsResult { Result?: WorkspacesIpGroup[]; /** - *

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

+ *

The token to use to retrieve the next page of results. This value is null when there are + * no more results to return.

*/ NextToken?: string; } @@ -2042,7 +2393,8 @@ export namespace DescribeIpGroupsResult { export interface DescribeTagsRequest { /** *

The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, - * registered directories, images, custom bundles, IP access control groups, and connection aliases.

+ * registered directories, images, custom bundles, IP access control groups, and connection + * aliases.

*/ ResourceId: string | undefined; } @@ -2237,8 +2589,8 @@ export interface WorkspaceAccessProperties { DeviceTypeIos?: AccessPropertyValue | string; /** - *

Indicates whether users can use Android and Android-compatible Chrome OS devices - * to access their WorkSpaces.

+ *

Indicates whether users can use Android and Android-compatible Chrome OS devices to + * access their WorkSpaces.

*/ DeviceTypeAndroid?: AccessPropertyValue | string; @@ -2325,12 +2677,11 @@ export interface WorkspaceDirectory { /** *

The state of the directory's registration with Amazon WorkSpaces. After a directory is - * deregistered, the DEREGISTERED state is returned very briefly before the directory - * metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, - * check for the directory ID by using - * - * DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been - * successfully deregistered.

+ * deregistered, the DEREGISTERED state is returned very briefly before the + * directory metadata is cleaned up, so this state is rarely returned. To confirm that a + * directory is deregistered, check for the directory ID by using + * DescribeWorkspaceDirectories. If the directory ID isn't returned, then the + * directory has been successfully deregistered.

*/ State?: WorkspaceDirectoryState | string; @@ -2378,7 +2729,8 @@ export interface DescribeWorkspaceDirectoriesResult { Directories?: WorkspaceDirectory[]; /** - *

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

+ *

The token to use to retrieve the next page of results. This value is null when there are + * no more results to return.

*/ NextToken?: string; } @@ -2420,14 +2772,14 @@ export namespace DescribeWorkspaceImagePermissionsRequest { } /** - *

Describes the Amazon Web Services accounts that have been granted permission to use a shared image. - * For more information about sharing images, see - * - * Share or Unshare a Custom WorkSpaces Image.

+ *

Describes the Amazon Web Services accounts that have been granted permission to use a + * shared image. For more information about sharing images, see Share or Unshare a Custom + * WorkSpaces Image.

*/ export interface ImagePermission { /** - *

The identifier of the Amazon Web Services account that an image has been shared with.

+ *

The identifier of the Amazon Web Services account that an image has been shared + * with.

*/ SharedAccountId?: string; } @@ -2448,12 +2800,14 @@ export interface DescribeWorkspaceImagePermissionsResult { ImageId?: string; /** - *

The identifiers of the Amazon Web Services accounts that the image has been shared with.

+ *

The identifiers of the Amazon Web Services accounts that the image has been shared + * with.

*/ ImagePermissions?: ImagePermission[]; /** - *

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

+ *

The token to use to retrieve the next page of results. This value is null when there are + * no more results to return.

*/ NextToken?: string; } @@ -2540,21 +2894,22 @@ export enum WorkspaceImageState { } /** - *

Describes whether a WorkSpace image needs to be updated with the latest - * drivers and other components required by Amazon WorkSpaces.

- * + *

Describes whether a WorkSpace image needs to be updated with the latest drivers and + * other components required by Amazon WorkSpaces.

* *

Only Windows 10 WorkSpace images can be programmatically updated at this time.

* */ export interface UpdateResult { /** - *

Indicates whether updated drivers or other components are available for the specified WorkSpace image.

+ *

Indicates whether updated drivers or other components are available for the specified + * WorkSpace image.

*/ UpdateAvailable?: boolean; /** - *

A description of whether updates for the WorkSpace image are pending or available.

+ *

A description of whether updates for the WorkSpace image are pending or + * available.

*/ Description?: string; } @@ -2616,8 +2971,8 @@ export interface WorkspaceImage { ErrorMessage?: string; /** - *

The date when the image was created. If the image has been shared, the Amazon Web Services account - * that the image has been shared with sees the original creation date of the image.

+ *

The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date + * of the image.

*/ Created?: Date; @@ -2648,7 +3003,8 @@ export interface DescribeWorkspaceImagesResult { Images?: WorkspaceImage[]; /** - *

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

+ *

The token to use to retrieve the next page of results. This value is null when there are + * no more results to return.

*/ NextToken?: string; } @@ -2720,7 +3076,8 @@ export interface DescribeWorkspacesResult { Workspaces?: Workspace[]; /** - *

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

+ *

The token to use to retrieve the next page of results. This value is null when there are + * no more results to return.

*/ NextToken?: string; } @@ -2798,7 +3155,8 @@ export interface DescribeWorkspacesConnectionStatusResult { WorkspacesConnectionStatus?: WorkspaceConnectionStatus[]; /** - *

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

+ *

The token to use to retrieve the next page of results. This value is null when there are + * no more results to return.

*/ NextToken?: string; } @@ -2849,8 +3207,8 @@ export namespace Snapshot { export interface DescribeWorkspaceSnapshotsResult { /** - *

Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include - * the user volume.

+ *

Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots + * include the user volume.

*/ RebuildSnapshots?: Snapshot[]; @@ -2930,9 +3288,8 @@ export namespace DisassociateIpGroupsResult { } /** - *

Describes a WorkSpace that could not be rebooted. - * (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated - * (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).

+ *

Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), + * rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).

*/ export interface FailedWorkspaceChangeRequest { /** @@ -2961,6 +3318,188 @@ export namespace FailedWorkspaceChangeRequest { }); } +/** + *

The client branding attributes to import for iOS device types. These attributes are + * displayed on the iOS client login screen.

+ * + *

Client branding attributes are public facing. Ensure you do not include sensitive + * information.

+ * + */ +export interface IosImportClientBrandingAttributes { + /** + *

The logo. This is the link where users can download the logo image. This is the + * standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal + * to one point.

+ */ + Logo?: Uint8Array; + + /** + *

The @2x version of the logo. This is the higher resolution display that offers a scale + * factor of 2.0 (or @2x).

+ * + *

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface + * Guidelines.

+ * + */ + Logo2x?: Uint8Array; + + /** + *

The @3x version of the logo. This is the higher resolution display that offers a scale + * factor of 3.0 (or @3x).

+ * + *

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface + * Guidelines.

+ * + */ + Logo3x?: Uint8Array; + + /** + *

The support email. The company's customer support email address.

+ * + *
    + *
  • + *

    In each platform type, the SupportEmail and + * SupportLink parameters are mutually exclusive. You can specify one + * parameter for each platform type, but not both.

    + *
    • + *
  • + *

    The default email is workspaces-feedback@amazon.com.

    + *
    • + *
+ * + */ + SupportEmail?: string; + + /** + *

The support link. The link for the company's customer support page for their + * WorkSpace.

+ * + *
    + *
  • + *

    In each platform type, the SupportEmail and + * SupportLink parameters are mutually exclusive. You can specify one + * parameter for each platform type, but not both.

    + *
    • + *
  • + *

    The default support link is workspaces-feedback@amazon.com.

    + *
    • + *
+ * + */ + SupportLink?: string; + + /** + *

The forgotten password link. This is the web address that users can go to if they forget + * the password for their WorkSpace.

+ */ + ForgotPasswordLink?: string; + + /** + *

The login message. Specified as a key value pair, in which the key is a locale and the + * value is the localized message for that locale. The only key supported is + * en_US.

+ */ + LoginMessage?: { [key: string]: string }; +} + +export namespace IosImportClientBrandingAttributes { + /** + * @internal + */ + export const filterSensitiveLog = (obj: IosImportClientBrandingAttributes): any => ({ + ...obj, + }); +} + +export interface ImportClientBrandingRequest { + /** + *

The directory identifier of the WorkSpace for which you want to import client + * branding.

+ */ + ResourceId: string | undefined; + + /** + *

The branding information to import for Windows devices.

+ */ + DeviceTypeWindows?: DefaultImportClientBrandingAttributes; + + /** + *

The branding information to import for macOS devices.

+ */ + DeviceTypeOsx?: DefaultImportClientBrandingAttributes; + + /** + *

The branding information to import for Android devices.

+ */ + DeviceTypeAndroid?: DefaultImportClientBrandingAttributes; + + /** + *

The branding information to import for iOS devices.

+ */ + DeviceTypeIos?: IosImportClientBrandingAttributes; + + /** + *

The branding information to import for Linux devices.

+ */ + DeviceTypeLinux?: DefaultImportClientBrandingAttributes; + + /** + *

The branding information to import for web access.

+ */ + DeviceTypeWeb?: DefaultImportClientBrandingAttributes; +} + +export namespace ImportClientBrandingRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ImportClientBrandingRequest): any => ({ + ...obj, + }); +} + +export interface ImportClientBrandingResult { + /** + *

The branding information configured for Windows devices.

+ */ + DeviceTypeWindows?: DefaultClientBrandingAttributes; + + /** + *

The branding information configured for macOS devices.

+ */ + DeviceTypeOsx?: DefaultClientBrandingAttributes; + + /** + *

The branding information configured for Android devices.

+ */ + DeviceTypeAndroid?: DefaultClientBrandingAttributes; + + /** + *

The branding information configured for iOS devices.

+ */ + DeviceTypeIos?: IosClientBrandingAttributes; + + /** + *

The branding information configured for Linux devices.

+ */ + DeviceTypeLinux?: DefaultClientBrandingAttributes; + + /** + *

The branding information configured for web access.

+ */ + DeviceTypeWeb?: DefaultClientBrandingAttributes; +} + +export namespace ImportClientBrandingResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ImportClientBrandingResult): any => ({ + ...obj, + }); +} + export enum WorkspaceImageIngestionProcess { BYOL_GRAPHICS = "BYOL_GRAPHICS", BYOL_GRAPHICSPRO = "BYOL_GRAPHICSPRO", @@ -2976,12 +3515,12 @@ export interface ImportWorkspaceImageRequest { /** *

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 or WorkSpaces Streaming Protocol - * (WSP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value - * that does not end in _WSP.

- * + * you want to use for your BYOL Workspace image, either PCoIP or WorkSpaces Streaming + * Protocol (WSP). To use WSP, specify a value that ends in _WSP. To use PCoIP, + * specify a value that does not end in _WSP.

*

For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify - * BYOL_REGULAR or BYOL_REGULAR_WSP, depending on the protocol.

+ * BYOL_REGULAR or BYOL_REGULAR_WSP, depending on the + * protocol.

*/ IngestionProcess: WorkspaceImageIngestionProcess | string | undefined; @@ -3002,10 +3541,8 @@ export interface ImportWorkspaceImageRequest { /** *

If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 - * BYOL images. For more information about subscribing to Office for BYOL images, see - * - * Bring Your Own Windows Desktop Licenses.

- * + * BYOL images. For more information about subscribing to Office for BYOL images, see Bring + * Your Own Windows Desktop Licenses.

* *

Although this parameter is an array, only one item is allowed at this time.

* @@ -3073,7 +3610,8 @@ export interface ListAvailableManagementCidrRangesResult { ManagementCidrRanges?: string[]; /** - *

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

+ *

The token to use to retrieve the next page of results. This value is null when there are + * no more results to return.

*/ NextToken?: string; } @@ -3115,8 +3653,9 @@ export interface MigrateWorkspaceResult { SourceWorkspaceId?: string; /** - *

The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, - * the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.

+ *

The new identifier of the WorkSpace that is being migrated. If the migration does not + * succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the + * original WorkSpace ID.

*/ TargetWorkspaceId?: string; } @@ -3289,18 +3828,17 @@ export namespace ModifyWorkspaceAccessPropertiesResult { export interface WorkspaceCreationProperties { /** *

Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

- * * - *

If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the - * directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless - * you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, - * see Disabling Users in the - * Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see - * Deleting a Site in the - * Amazon WorkDocs Administration Guide.

- * - *

If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any - * new WorkSpaces that are launched in the directory will have WorkDocs enabled.

+ *

If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new + * WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs + * remains enabled for any existing WorkSpaces, unless you either disable users' access to + * WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see + * Disabling Users in the Amazon WorkDocs Administration + * Guide. To delete a WorkDocs site, see Deleting a Site in the + * Amazon WorkDocs Administration Guide.

+ *

If you enable WorkDocs on a directory that already has existing WorkSpaces, the + * existing WorkSpaces and any new WorkSpaces that are launched in the directory will have + * WorkDocs enabled.

* */ EnableWorkDocs?: boolean; @@ -3311,18 +3849,18 @@ export interface WorkspaceCreationProperties { EnableInternetAccess?: boolean; /** - *

The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight - * Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form - * "OU=value,DC=value,DC=value", - * where value is any string of characters, and the number of domain components (DCs) is - * two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

- * + *

The default organizational unit (OU) for your WorkSpaces directories. This string must + * be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target + * domain and OU. It must be in the form + * "OU=value,DC=value,DC=value", + * where value is any string of characters, and the number of domain + * components (DCs) is two or more. For example, + * OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

* *
    *
  • - *

    To avoid errors, certain characters in the distinguished name must be escaped. For more information, - * see - * Distinguished Names in the Microsoft documentation.

    + *

    To avoid errors, certain characters in the distinguished name must be escaped. + * For more information, see Distinguished Names in the Microsoft documentation.

    *
    • *
  • *

    The API doesn't validate whether the OU exists.

    @@ -3585,25 +4123,28 @@ export namespace RebuildWorkspacesResult { export interface RegisterWorkspaceDirectoryRequest { /** - *

    The identifier of the directory. You cannot register a directory if it does not have a status - * of Active. If the directory does not have a status of Active, you will receive an - * InvalidResourceStateException error. If you have already registered the maximum number of directories - * that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. - * Deregister directories that you are not using for WorkSpaces, and try again.

    + *

    The identifier of the directory. You cannot register a directory if it does not have a + * status of Active. If the directory does not have a status of Active, you will receive an + * InvalidResourceStateException error. If you have already registered the maximum number of + * directories that you can register with Amazon WorkSpaces, you will receive a + * ResourceLimitExceededException error. Deregister directories that you are not using for + * WorkSpaces, and try again.

    */ DirectoryId: string | undefined; /** - *

    The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets - * are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these - * conditions are not met, you will receive an OperationNotSupportedException error.

    + *

    The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the + * subnets are in supported Availability Zones. The subnets must also be in separate + * Availability Zones. If these conditions are not met, you will receive an + * OperationNotSupportedException error.

    */ SubnetIds?: string[]; /** - *

    Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and - * WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set - * EnableWorkDocs to disabled, and try again.

    + *

    Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this + * parameter and WorkDocs is not available in the Region, you will receive an + * OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try + * again.

    */ EnableWorkDocs: boolean | undefined; @@ -3614,10 +4155,10 @@ export interface RegisterWorkspaceDirectoryRequest { /** *

    Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own - * License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be - * enabled for BYOL. If your account has not been enabled for BYOL, you will receive an - * InvalidParameterValuesException error. For more information about BYOL images, see - * Bring Your Own Windows Desktop Images.

    + * License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for + * BYOL, you will receive an InvalidParameterValuesException error. For more information about + * BYOL images, see Bring Your Own Windows + * Desktop Images.

    */ Tenancy?: Tenancy | string; @@ -4046,14 +4587,14 @@ export interface UpdateWorkspaceImagePermissionRequest { ImageId: string | undefined; /** - *

    The permission to copy the image. This permission can be revoked only after an image - * has been shared.

    + *

    The permission to copy the image. This permission can be revoked only after an image has + * been shared.

    */ AllowCopyImage: boolean | undefined; /** - *

    The identifier of the Amazon Web Services account to share or unshare the image with.

    - * + *

    The identifier of the Amazon Web Services account to share or unshare the image + * with.

    * *

    Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.

    *     diff --git a/clients/client-workspaces/src/protocols/Aws_json1_1.ts b/clients/client-workspaces/src/protocols/Aws_json1_1.ts index 8c6d322636d9..8748aad1f0ab 100644 --- a/clients/client-workspaces/src/protocols/Aws_json1_1.ts +++ b/clients/client-workspaces/src/protocols/Aws_json1_1.ts @@ -41,6 +41,10 @@ import { CreateWorkspaceBundleCommandOutput, } from "../commands/CreateWorkspaceBundleCommand"; import { CreateWorkspacesCommandInput, CreateWorkspacesCommandOutput } from "../commands/CreateWorkspacesCommand"; +import { + DeleteClientBrandingCommandInput, + DeleteClientBrandingCommandOutput, +} from "../commands/DeleteClientBrandingCommand"; import { DeleteConnectClientAddInCommandInput, DeleteConnectClientAddInCommandOutput, @@ -68,6 +72,10 @@ import { DescribeAccountModificationsCommandInput, DescribeAccountModificationsCommandOutput, } from "../commands/DescribeAccountModificationsCommand"; +import { + DescribeClientBrandingCommandInput, + DescribeClientBrandingCommandOutput, +} from "../commands/DescribeClientBrandingCommand"; import { DescribeClientPropertiesCommandInput, DescribeClientPropertiesCommandOutput, @@ -119,6 +127,10 @@ import { DisassociateIpGroupsCommandInput, DisassociateIpGroupsCommandOutput, } from "../commands/DisassociateIpGroupsCommand"; +import { + ImportClientBrandingCommandInput, + ImportClientBrandingCommandOutput, +} from "../commands/ImportClientBrandingCommand"; import { ImportWorkspaceImageCommandInput, ImportWorkspaceImageCommandOutput, @@ -197,6 +209,7 @@ import { AssociateIpGroupsResult, AuthorizeIpRulesRequest, AuthorizeIpRulesResult, + ClientDeviceType, ClientProperties, ClientPropertiesResult, ComputeType, @@ -220,7 +233,11 @@ import { CreateWorkspaceBundleResult, CreateWorkspacesRequest, CreateWorkspacesResult, + DefaultClientBrandingAttributes, + DefaultImportClientBrandingAttributes, DefaultWorkspaceCreationProperties, + DeleteClientBrandingRequest, + DeleteClientBrandingResult, DeleteConnectClientAddInRequest, DeleteConnectClientAddInResult, DeleteConnectionAliasRequest, @@ -239,6 +256,8 @@ import { DescribeAccountModificationsResult, DescribeAccountRequest, DescribeAccountResult, + DescribeClientBrandingRequest, + DescribeClientBrandingResult, DescribeClientPropertiesRequest, DescribeClientPropertiesResult, DescribeConnectClientAddInsRequest, @@ -272,10 +291,14 @@ import { FailedCreateWorkspaceRequest, FailedWorkspaceChangeRequest, ImagePermission, + ImportClientBrandingRequest, + ImportClientBrandingResult, ImportWorkspaceImageRequest, ImportWorkspaceImageResult, InvalidParameterValuesException, InvalidResourceStateException, + IosClientBrandingAttributes, + IosImportClientBrandingAttributes, IpRuleItem, ListAvailableManagementCidrRangesRequest, ListAvailableManagementCidrRangesResult, @@ -501,6 +524,19 @@ export const serializeAws_json1_1CreateWorkspacesCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1DeleteClientBrandingCommand = async ( + input: DeleteClientBrandingCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "WorkspacesService.DeleteClientBranding", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DeleteClientBrandingRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1DeleteConnectClientAddInCommand = async ( input: DeleteConnectClientAddInCommandInput, context: __SerdeContext @@ -618,6 +654,19 @@ export const serializeAws_json1_1DescribeAccountModificationsCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1DescribeClientBrandingCommand = async ( + input: DescribeClientBrandingCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "WorkspacesService.DescribeClientBranding", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DescribeClientBrandingRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1DescribeClientPropertiesCommand = async ( input: DescribeClientPropertiesCommandInput, context: __SerdeContext @@ -813,6 +862,19 @@ export const serializeAws_json1_1DisassociateIpGroupsCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1ImportClientBrandingCommand = async ( + input: ImportClientBrandingCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "WorkspacesService.ImportClientBranding", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1ImportClientBrandingRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1ImportWorkspaceImageCommand = async ( input: ImportWorkspaceImageCommandInput, context: __SerdeContext @@ -1726,6 +1788,55 @@ const deserializeAws_json1_1CreateWorkspacesCommandError = async ( } }; +export const deserializeAws_json1_1DeleteClientBrandingCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return deserializeAws_json1_1DeleteClientBrandingCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = deserializeAws_json1_1DeleteClientBrandingResult(data, context); + const response: DeleteClientBrandingCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return Promise.resolve(response); +}; + +const deserializeAws_json1_1DeleteClientBrandingCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __BaseException; + let errorCode = "UnknownError"; + errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "AccessDeniedException": + case "com.amazonaws.workspaces#AccessDeniedException": + throw await deserializeAws_json1_1AccessDeniedExceptionResponse(parsedOutput, context); + case "InvalidParameterValuesException": + case "com.amazonaws.workspaces#InvalidParameterValuesException": + throw await deserializeAws_json1_1InvalidParameterValuesExceptionResponse(parsedOutput, context); + case "ResourceNotFoundException": + case "com.amazonaws.workspaces#ResourceNotFoundException": + throw await deserializeAws_json1_1ResourceNotFoundExceptionResponse(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + response = new __BaseException({ + name: parsedBody.code || parsedBody.Code || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + }); + throw __decorateServiceException(response, parsedBody); + } +}; + export const deserializeAws_json1_1DeleteConnectClientAddInCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -2173,6 +2284,55 @@ const deserializeAws_json1_1DescribeAccountModificationsCommandError = async ( } }; +export const deserializeAws_json1_1DescribeClientBrandingCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return deserializeAws_json1_1DescribeClientBrandingCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = deserializeAws_json1_1DescribeClientBrandingResult(data, context); + const response: DescribeClientBrandingCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return Promise.resolve(response); +}; + +const deserializeAws_json1_1DescribeClientBrandingCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __BaseException; + let errorCode = "UnknownError"; + errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "AccessDeniedException": + case "com.amazonaws.workspaces#AccessDeniedException": + throw await deserializeAws_json1_1AccessDeniedExceptionResponse(parsedOutput, context); + case "InvalidParameterValuesException": + case "com.amazonaws.workspaces#InvalidParameterValuesException": + throw await deserializeAws_json1_1InvalidParameterValuesExceptionResponse(parsedOutput, context); + case "ResourceNotFoundException": + case "com.amazonaws.workspaces#ResourceNotFoundException": + throw await deserializeAws_json1_1ResourceNotFoundExceptionResponse(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + response = new __BaseException({ + name: parsedBody.code || parsedBody.Code || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + }); + throw __decorateServiceException(response, parsedBody); + } +}; + export const deserializeAws_json1_1DescribeClientPropertiesCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -2884,6 +3044,55 @@ const deserializeAws_json1_1DisassociateIpGroupsCommandError = async ( } }; +export const deserializeAws_json1_1ImportClientBrandingCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return deserializeAws_json1_1ImportClientBrandingCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = deserializeAws_json1_1ImportClientBrandingResult(data, context); + const response: ImportClientBrandingCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return Promise.resolve(response); +}; + +const deserializeAws_json1_1ImportClientBrandingCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __BaseException; + let errorCode = "UnknownError"; + errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "AccessDeniedException": + case "com.amazonaws.workspaces#AccessDeniedException": + throw await deserializeAws_json1_1AccessDeniedExceptionResponse(parsedOutput, context); + case "InvalidParameterValuesException": + case "com.amazonaws.workspaces#InvalidParameterValuesException": + throw await deserializeAws_json1_1InvalidParameterValuesExceptionResponse(parsedOutput, context); + case "ResourceLimitExceededException": + case "com.amazonaws.workspaces#ResourceLimitExceededException": + throw await deserializeAws_json1_1ResourceLimitExceededExceptionResponse(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + response = new __BaseException({ + name: parsedBody.code || parsedBody.Code || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + }); + throw __decorateServiceException(response, parsedBody); + } +}; + export const deserializeAws_json1_1ImportWorkspaceImageCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -4277,6 +4486,20 @@ const serializeAws_json1_1BundleIdList = (input: string[], context: __SerdeConte }); }; +const serializeAws_json1_1ClientDeviceTypeList = ( + input: (ClientDeviceType | string)[], + context: __SerdeContext +): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + if (entry === null) { + return null as any; + } + return entry; + }); +}; + const serializeAws_json1_1ClientProperties = (input: ClientProperties, context: __SerdeContext): any => { return { ...(input.ReconnectEnabled !== undefined && @@ -4403,6 +4626,32 @@ const serializeAws_json1_1CreateWorkspacesRequest = (input: CreateWorkspacesRequ }; }; +const serializeAws_json1_1DefaultImportClientBrandingAttributes = ( + input: DefaultImportClientBrandingAttributes, + context: __SerdeContext +): any => { + return { + ...(input.ForgotPasswordLink !== undefined && + input.ForgotPasswordLink !== null && { ForgotPasswordLink: input.ForgotPasswordLink }), + ...(input.LoginMessage !== undefined && + input.LoginMessage !== null && { LoginMessage: serializeAws_json1_1LoginMessage(input.LoginMessage, context) }), + ...(input.Logo !== undefined && input.Logo !== null && { Logo: context.base64Encoder(input.Logo) }), + ...(input.SupportEmail !== undefined && input.SupportEmail !== null && { SupportEmail: input.SupportEmail }), + ...(input.SupportLink !== undefined && input.SupportLink !== null && { SupportLink: input.SupportLink }), + }; +}; + +const serializeAws_json1_1DeleteClientBrandingRequest = ( + input: DeleteClientBrandingRequest, + context: __SerdeContext +): any => { + return { + ...(input.Platforms !== undefined && + input.Platforms !== null && { Platforms: serializeAws_json1_1ClientDeviceTypeList(input.Platforms, context) }), + ...(input.ResourceId !== undefined && input.ResourceId !== null && { ResourceId: input.ResourceId }), + }; +}; + const serializeAws_json1_1DeleteConnectClientAddInRequest = ( input: DeleteConnectClientAddInRequest, context: __SerdeContext @@ -4476,6 +4725,15 @@ const serializeAws_json1_1DescribeAccountRequest = (input: DescribeAccountReques return {}; }; +const serializeAws_json1_1DescribeClientBrandingRequest = ( + input: DescribeClientBrandingRequest, + context: __SerdeContext +): any => { + return { + ...(input.ResourceId !== undefined && input.ResourceId !== null && { ResourceId: input.ResourceId }), + }; +}; + const serializeAws_json1_1DescribeClientPropertiesRequest = ( input: DescribeClientPropertiesRequest, context: __SerdeContext @@ -4656,6 +4914,39 @@ const serializeAws_json1_1DisassociateIpGroupsRequest = ( }; }; +const serializeAws_json1_1ImportClientBrandingRequest = ( + input: ImportClientBrandingRequest, + context: __SerdeContext +): any => { + return { + ...(input.DeviceTypeAndroid !== undefined && + input.DeviceTypeAndroid !== null && { + DeviceTypeAndroid: serializeAws_json1_1DefaultImportClientBrandingAttributes(input.DeviceTypeAndroid, context), + }), + ...(input.DeviceTypeIos !== undefined && + input.DeviceTypeIos !== null && { + DeviceTypeIos: serializeAws_json1_1IosImportClientBrandingAttributes(input.DeviceTypeIos, context), + }), + ...(input.DeviceTypeLinux !== undefined && + input.DeviceTypeLinux !== null && { + DeviceTypeLinux: serializeAws_json1_1DefaultImportClientBrandingAttributes(input.DeviceTypeLinux, context), + }), + ...(input.DeviceTypeOsx !== undefined && + input.DeviceTypeOsx !== null && { + DeviceTypeOsx: serializeAws_json1_1DefaultImportClientBrandingAttributes(input.DeviceTypeOsx, context), + }), + ...(input.DeviceTypeWeb !== undefined && + input.DeviceTypeWeb !== null && { + DeviceTypeWeb: serializeAws_json1_1DefaultImportClientBrandingAttributes(input.DeviceTypeWeb, context), + }), + ...(input.DeviceTypeWindows !== undefined && + input.DeviceTypeWindows !== null && { + DeviceTypeWindows: serializeAws_json1_1DefaultImportClientBrandingAttributes(input.DeviceTypeWindows, context), + }), + ...(input.ResourceId !== undefined && input.ResourceId !== null && { ResourceId: input.ResourceId }), + }; +}; + const serializeAws_json1_1ImportWorkspaceImageRequest = ( input: ImportWorkspaceImageRequest, context: __SerdeContext @@ -4675,6 +4966,23 @@ const serializeAws_json1_1ImportWorkspaceImageRequest = ( }; }; +const serializeAws_json1_1IosImportClientBrandingAttributes = ( + input: IosImportClientBrandingAttributes, + context: __SerdeContext +): any => { + return { + ...(input.ForgotPasswordLink !== undefined && + input.ForgotPasswordLink !== null && { ForgotPasswordLink: input.ForgotPasswordLink }), + ...(input.LoginMessage !== undefined && + input.LoginMessage !== null && { LoginMessage: serializeAws_json1_1LoginMessage(input.LoginMessage, context) }), + ...(input.Logo !== undefined && input.Logo !== null && { Logo: context.base64Encoder(input.Logo) }), + ...(input.Logo2x !== undefined && input.Logo2x !== null && { Logo2x: context.base64Encoder(input.Logo2x) }), + ...(input.Logo3x !== undefined && input.Logo3x !== null && { Logo3x: context.base64Encoder(input.Logo3x) }), + ...(input.SupportEmail !== undefined && input.SupportEmail !== null && { SupportEmail: input.SupportEmail }), + ...(input.SupportLink !== undefined && input.SupportLink !== null && { SupportLink: input.SupportLink }), + }; +}; + const serializeAws_json1_1IpGroupIdList = (input: string[], context: __SerdeContext): any => { return input .filter((e: any) => e != null) @@ -4729,6 +5037,18 @@ const serializeAws_json1_1ListAvailableManagementCidrRangesRequest = ( }; }; +const serializeAws_json1_1LoginMessage = (input: { [key: string]: string }, context: __SerdeContext): any => { + return Object.entries(input).reduce((acc: { [key: string]: any }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: value, + }; + }, {}); +}; + const serializeAws_json1_1MigrateWorkspaceRequest = (input: MigrateWorkspaceRequest, context: __SerdeContext): any => { return { ...(input.BundleId !== undefined && input.BundleId !== null && { BundleId: input.BundleId }), @@ -5529,6 +5849,22 @@ const deserializeAws_json1_1DedicatedTenancyCidrRangeList = (output: any, contex return retVal; }; +const deserializeAws_json1_1DefaultClientBrandingAttributes = ( + output: any, + context: __SerdeContext +): DefaultClientBrandingAttributes => { + return { + ForgotPasswordLink: __expectString(output.ForgotPasswordLink), + LoginMessage: + output.LoginMessage !== undefined && output.LoginMessage !== null + ? deserializeAws_json1_1LoginMessage(output.LoginMessage, context) + : undefined, + LogoUrl: __expectString(output.LogoUrl), + SupportEmail: __expectString(output.SupportEmail), + SupportLink: __expectString(output.SupportLink), + } as any; +}; + const deserializeAws_json1_1DefaultWorkspaceCreationProperties = ( output: any, context: __SerdeContext @@ -5543,6 +5879,13 @@ const deserializeAws_json1_1DefaultWorkspaceCreationProperties = ( } as any; }; +const deserializeAws_json1_1DeleteClientBrandingResult = ( + output: any, + context: __SerdeContext +): DeleteClientBrandingResult => { + return {} as any; +}; + const deserializeAws_json1_1DeleteConnectClientAddInResult = ( output: any, context: __SerdeContext @@ -5606,6 +5949,38 @@ const deserializeAws_json1_1DescribeAccountResult = (output: any, context: __Ser } as any; }; +const deserializeAws_json1_1DescribeClientBrandingResult = ( + output: any, + context: __SerdeContext +): DescribeClientBrandingResult => { + return { + DeviceTypeAndroid: + output.DeviceTypeAndroid !== undefined && output.DeviceTypeAndroid !== null + ? deserializeAws_json1_1DefaultClientBrandingAttributes(output.DeviceTypeAndroid, context) + : undefined, + DeviceTypeIos: + output.DeviceTypeIos !== undefined && output.DeviceTypeIos !== null + ? deserializeAws_json1_1IosClientBrandingAttributes(output.DeviceTypeIos, context) + : undefined, + DeviceTypeLinux: + output.DeviceTypeLinux !== undefined && output.DeviceTypeLinux !== null + ? deserializeAws_json1_1DefaultClientBrandingAttributes(output.DeviceTypeLinux, context) + : undefined, + DeviceTypeOsx: + output.DeviceTypeOsx !== undefined && output.DeviceTypeOsx !== null + ? deserializeAws_json1_1DefaultClientBrandingAttributes(output.DeviceTypeOsx, context) + : undefined, + DeviceTypeWeb: + output.DeviceTypeWeb !== undefined && output.DeviceTypeWeb !== null + ? deserializeAws_json1_1DefaultClientBrandingAttributes(output.DeviceTypeWeb, context) + : undefined, + DeviceTypeWindows: + output.DeviceTypeWindows !== undefined && output.DeviceTypeWindows !== null + ? deserializeAws_json1_1DefaultClientBrandingAttributes(output.DeviceTypeWindows, context) + : undefined, + } as any; +}; + const deserializeAws_json1_1DescribeClientPropertiesResult = ( output: any, context: __SerdeContext @@ -5943,6 +6318,38 @@ const deserializeAws_json1_1ImagePermissions = (output: any, context: __SerdeCon return retVal; }; +const deserializeAws_json1_1ImportClientBrandingResult = ( + output: any, + context: __SerdeContext +): ImportClientBrandingResult => { + return { + DeviceTypeAndroid: + output.DeviceTypeAndroid !== undefined && output.DeviceTypeAndroid !== null + ? deserializeAws_json1_1DefaultClientBrandingAttributes(output.DeviceTypeAndroid, context) + : undefined, + DeviceTypeIos: + output.DeviceTypeIos !== undefined && output.DeviceTypeIos !== null + ? deserializeAws_json1_1IosClientBrandingAttributes(output.DeviceTypeIos, context) + : undefined, + DeviceTypeLinux: + output.DeviceTypeLinux !== undefined && output.DeviceTypeLinux !== null + ? deserializeAws_json1_1DefaultClientBrandingAttributes(output.DeviceTypeLinux, context) + : undefined, + DeviceTypeOsx: + output.DeviceTypeOsx !== undefined && output.DeviceTypeOsx !== null + ? deserializeAws_json1_1DefaultClientBrandingAttributes(output.DeviceTypeOsx, context) + : undefined, + DeviceTypeWeb: + output.DeviceTypeWeb !== undefined && output.DeviceTypeWeb !== null + ? deserializeAws_json1_1DefaultClientBrandingAttributes(output.DeviceTypeWeb, context) + : undefined, + DeviceTypeWindows: + output.DeviceTypeWindows !== undefined && output.DeviceTypeWindows !== null + ? deserializeAws_json1_1DefaultClientBrandingAttributes(output.DeviceTypeWindows, context) + : undefined, + } as any; +}; + const deserializeAws_json1_1ImportWorkspaceImageResult = ( output: any, context: __SerdeContext @@ -5970,6 +6377,24 @@ const deserializeAws_json1_1InvalidResourceStateException = ( } as any; }; +const deserializeAws_json1_1IosClientBrandingAttributes = ( + output: any, + context: __SerdeContext +): IosClientBrandingAttributes => { + return { + ForgotPasswordLink: __expectString(output.ForgotPasswordLink), + LoginMessage: + output.LoginMessage !== undefined && output.LoginMessage !== null + ? deserializeAws_json1_1LoginMessage(output.LoginMessage, context) + : undefined, + Logo2xUrl: __expectString(output.Logo2xUrl), + Logo3xUrl: __expectString(output.Logo3xUrl), + LogoUrl: __expectString(output.LogoUrl), + SupportEmail: __expectString(output.SupportEmail), + SupportLink: __expectString(output.SupportLink), + } as any; +}; + const deserializeAws_json1_1IpGroupIdList = (output: any, context: __SerdeContext): string[] => { const retVal = (output || []) .filter((e: any) => e != null) @@ -6014,6 +6439,18 @@ const deserializeAws_json1_1ListAvailableManagementCidrRangesResult = ( } as any; }; +const deserializeAws_json1_1LoginMessage = (output: any, context: __SerdeContext): { [key: string]: string } => { + return Object.entries(output).reduce((acc: { [key: string]: string }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: __expectString(value) as any, + }; + }, {}); +}; + const deserializeAws_json1_1MigrateWorkspaceResult = (output: any, context: __SerdeContext): MigrateWorkspaceResult => { return { SourceWorkspaceId: __expectString(output.SourceWorkspaceId), diff --git a/codegen/sdk-codegen/aws-models/workspaces.json b/codegen/sdk-codegen/aws-models/workspaces.json index 549768841521..d43afeef9996 100644 --- a/codegen/sdk-codegen/aws-models/workspaces.json +++ b/codegen/sdk-codegen/aws-models/workspaces.json @@ -1,5945 +1,6492 @@ { - "smithy": "1.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.workspaces#ARN": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws:[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,127}$" - } - }, - "com.amazonaws.workspaces#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

    The user is not authorized to access a resource.

    ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.workspaces#AccessPropertyValue": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALLOW", - "name": "ALLOW" - }, - { - "value": "DENY", - "name": "DENY" - } - ] - } - }, - "com.amazonaws.workspaces#AccountModification": { - "type": "structure", - "members": { - "ModificationState": { - "target": "com.amazonaws.workspaces#DedicatedTenancyModificationStateEnum", - "traits": { - "smithy.api#documentation": "

    The state of the modification to the configuration of BYOL.

    " - } - }, - "DedicatedTenancySupport": { - "target": "com.amazonaws.workspaces#DedicatedTenancySupportResultEnum", - "traits": { - "smithy.api#documentation": "

    The status of BYOL (whether BYOL is being enabled or disabled).

    " - } - }, - "DedicatedTenancyManagementCidrRange": { - "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange", - "traits": { - "smithy.api#documentation": "

    The IP address range, specified as an IPv4 CIDR block, for the management network\n interface used for the account.

    " - } - }, - "StartTime": { - "target": "com.amazonaws.workspaces#Timestamp", - "traits": { - "smithy.api#documentation": "

    The timestamp when the modification of the BYOL configuration was started.

    " - } - }, - "ErrorCode": { - "target": "com.amazonaws.workspaces#WorkspaceErrorCode", - "traits": { - "smithy.api#documentation": "

    The error code that is returned if the configuration of BYOL cannot be modified.

    " - } - }, - "ErrorMessage": { - "target": "com.amazonaws.workspaces#Description", - "traits": { - "smithy.api#documentation": "

    The text of the error message that is returned if the configuration of BYOL cannot be\n modified.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes a modification to the configuration of Bring Your Own License (BYOL) for the\n specified account.

    " - } - }, - "com.amazonaws.workspaces#AccountModificationList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#AccountModification" - } - }, - "com.amazonaws.workspaces#AddInName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.workspaces#AddInUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^(http|https)\\://\\S+$" - } - }, - "com.amazonaws.workspaces#Alias": { - "type": "string" - }, - "com.amazonaws.workspaces#AmazonUuid": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 - }, - "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.workspaces#Application": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Microsoft_Office_2016", - "name": "Microsoft_Office_2016" - }, - { - "value": "Microsoft_Office_2019", - "name": "Microsoft_Office_2019" - } - ] - } - }, - "com.amazonaws.workspaces#ApplicationList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#Application" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.workspaces#AssociateConnectionAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#AssociateConnectionAliasRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#AssociateConnectionAliasResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceAssociatedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Associates the specified connection alias with the specified directory to enable cross-Region redirection. \n For more information, see \n Cross-Region Redirection for Amazon WorkSpaces.

    \n \n \n

    Before performing this operation, call \n DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

    \n     " - } - }, - "com.amazonaws.workspaces#AssociateConnectionAliasRequest": { - "type": "structure", - "members": { - "AliasId": { - "target": "com.amazonaws.workspaces#ConnectionAliasId", - "traits": { - "smithy.api#documentation": "

    The identifier of the connection alias.

    ", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.workspaces#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The identifier of the directory to associate the connection alias with.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#AssociateConnectionAliasResult": { - "type": "structure", - "members": { - "ConnectionIdentifier": { - "target": "com.amazonaws.workspaces#ConnectionIdentifier", - "traits": { - "smithy.api#documentation": "

    The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when \n you're configuring your DNS routing policies.

    " - } - } - } - }, - "com.amazonaws.workspaces#AssociateIpGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#AssociateIpGroupsRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#AssociateIpGroupsResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Associates the specified IP access control group with the specified directory.

    " - } - }, - "com.amazonaws.workspaces#AssociateIpGroupsRequest": { - "type": "structure", - "members": { - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The identifier of the directory.

    ", - "smithy.api#required": {} - } - }, - "GroupIds": { - "target": "com.amazonaws.workspaces#IpGroupIdList", - "traits": { - "smithy.api#documentation": "

    The identifiers of one or more IP access control groups.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#AssociateIpGroupsResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#AssociationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NOT_ASSOCIATED", - "name": "NOT_ASSOCIATED" - }, - { - "value": "ASSOCIATED_WITH_OWNER_ACCOUNT", - "name": "ASSOCIATED_WITH_OWNER_ACCOUNT" - }, - { - "value": "ASSOCIATED_WITH_SHARED_ACCOUNT", - "name": "ASSOCIATED_WITH_SHARED_ACCOUNT" - }, - { - "value": "PENDING_ASSOCIATION", - "name": "PENDING_ASSOCIATION" - }, - { - "value": "PENDING_DISASSOCIATION", - "name": "PENDING_DISASSOCIATION" - } - ] - } - }, - "com.amazonaws.workspaces#AuthorizeIpRules": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#AuthorizeIpRulesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#AuthorizeIpRulesResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Adds one or more rules to the specified IP access control group.

    \n

    This action gives users permission to access their WorkSpaces from the CIDR address\n ranges specified in the rules.

    " - } - }, - "com.amazonaws.workspaces#AuthorizeIpRulesRequest": { - "type": "structure", - "members": { - "GroupId": { - "target": "com.amazonaws.workspaces#IpGroupId", - "traits": { - "smithy.api#documentation": "

    The identifier of the group.

    ", - "smithy.api#required": {} - } - }, - "UserRules": { - "target": "com.amazonaws.workspaces#IpRuleList", - "traits": { - "smithy.api#documentation": "

    The rules to add to the group.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#AuthorizeIpRulesResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#AwsAccount": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\d{12}$" - } - }, - "com.amazonaws.workspaces#BooleanObject": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } - }, - "com.amazonaws.workspaces#BundleId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^wsb-[0-9a-z]{8,63}$" - } - }, - "com.amazonaws.workspaces#BundleIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#BundleId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#BundleList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#WorkspaceBundle" - } - }, - "com.amazonaws.workspaces#BundleOwner": { - "type": "string" - }, - "com.amazonaws.workspaces#ClientProperties": { - "type": "structure", - "members": { - "ReconnectEnabled": { - "target": "com.amazonaws.workspaces#ReconnectEnum", - "traits": { - "smithy.api#documentation": "

    Specifies whether users can cache their credentials on the Amazon WorkSpaces client.\n When enabled, users can choose to reconnect to their WorkSpaces without re-entering their\n credentials.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes an Amazon WorkSpaces client.

    " - } - }, - "com.amazonaws.workspaces#ClientPropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#ClientPropertiesResult" - } - }, - "com.amazonaws.workspaces#ClientPropertiesResult": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.workspaces#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The resource identifier, in the form of a directory ID.

    " - } - }, - "ClientProperties": { - "target": "com.amazonaws.workspaces#ClientProperties", - "traits": { - "smithy.api#documentation": "

    Information about the Amazon WorkSpaces client.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Information about the Amazon WorkSpaces client.

    " - } - }, - "com.amazonaws.workspaces#Compute": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "VALUE", - "name": "VALUE" - }, - { - "value": "STANDARD", - "name": "STANDARD" - }, - { - "value": "PERFORMANCE", - "name": "PERFORMANCE" - }, - { - "value": "POWER", - "name": "POWER" - }, - { - "value": "GRAPHICS", - "name": "GRAPHICS" - }, - { - "value": "POWERPRO", - "name": "POWERPRO" - }, - { - "value": "GRAPHICSPRO", - "name": "GRAPHICSPRO" - } - ] - } - }, - "com.amazonaws.workspaces#ComputeType": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.workspaces#Compute", - "traits": { - "smithy.api#documentation": "

    The compute type.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes the compute type of the bundle.

    " - } - }, - "com.amazonaws.workspaces#ComputerName": { - "type": "string" - }, - "com.amazonaws.workspaces#ConnectClientAddIn": { - "type": "structure", - "members": { - "AddInId": { - "target": "com.amazonaws.workspaces#AmazonUuid", - "traits": { - "smithy.api#documentation": "

    The client add-in identifier.

    " - } - }, - "ResourceId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The directory identifier for which the client add-in is configured.

    " - } - }, - "Name": { - "target": "com.amazonaws.workspaces#AddInName", - "traits": { - "smithy.api#documentation": "

    The name of the client add in.

    " - } - }, - "URL": { - "target": "com.amazonaws.workspaces#AddInUrl", - "traits": { - "smithy.api#documentation": "

    The endpoint URL of the client add-in.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes an Amazon Connect client add-in.

    " - } - }, - "com.amazonaws.workspaces#ConnectClientAddInList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#ConnectClientAddIn" - } - }, - "com.amazonaws.workspaces#ConnectionAlias": { - "type": "structure", - "members": { - "ConnectionString": { - "target": "com.amazonaws.workspaces#ConnectionString", - "traits": { - "smithy.api#documentation": "

    The connection string specified for the connection alias. The connection string must be in the form of \n a fully qualified domain name (FQDN), such as www.example.com.

    " - } - }, - "AliasId": { - "target": "com.amazonaws.workspaces#ConnectionAliasId", - "traits": { - "smithy.api#documentation": "

    The identifier of the connection alias.

    " - } - }, - "State": { - "target": "com.amazonaws.workspaces#ConnectionAliasState", - "traits": { - "smithy.api#documentation": "

    The current state of the connection alias.

    " - } - }, - "OwnerAccountId": { - "target": "com.amazonaws.workspaces#AwsAccount", - "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Web Services account that owns the connection alias.

    " - } - }, - "Associations": { - "target": "com.amazonaws.workspaces#ConnectionAliasAssociationList", - "traits": { - "smithy.api#documentation": "

    The association status of the connection alias.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, \n see \n Cross-Region Redirection for Amazon WorkSpaces.

    " - } - }, - "com.amazonaws.workspaces#ConnectionAliasAssociation": { - "type": "structure", - "members": { - "AssociationStatus": { - "target": "com.amazonaws.workspaces#AssociationStatus", - "traits": { - "smithy.api#documentation": "

    The association status of the connection alias.

    " - } - }, - "AssociatedAccountId": { - "target": "com.amazonaws.workspaces#AwsAccount", - "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Web Services account that associated the connection alias with a directory.

    " - } - }, - "ResourceId": { - "target": "com.amazonaws.workspaces#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The identifier of the directory associated with a connection alias.

    " - } - }, - "ConnectionIdentifier": { - "target": "com.amazonaws.workspaces#ConnectionIdentifier", - "traits": { - "smithy.api#documentation": "

    The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when \n you're configuring your DNS routing policies.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes a connection alias association that is used for cross-Region redirection. For more information, see \n \n Cross-Region Redirection for Amazon WorkSpaces.

    " - } - }, - "com.amazonaws.workspaces#ConnectionAliasAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#ConnectionAliasAssociation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#ConnectionAliasId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 13, - "max": 68 - }, - "smithy.api#pattern": "^wsca-[0-9a-z]{8,63}$" - } - }, - "com.amazonaws.workspaces#ConnectionAliasIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#ConnectionAliasId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#ConnectionAliasList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#ConnectionAlias" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#ConnectionAliasPermission": { - "type": "structure", - "members": { - "SharedAccountId": { - "target": "com.amazonaws.workspaces#AwsAccount", - "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Web Services account that the connection alias is shared with.

    ", - "smithy.api#required": {} - } - }, - "AllowAssociation": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.

    ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes the permissions for a connection alias. Connection aliases are used for cross-Region redirection. \n For more information, see \n Cross-Region Redirection for Amazon WorkSpaces.

    " - } - }, - "com.amazonaws.workspaces#ConnectionAliasPermissions": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#ConnectionAliasPermission" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#ConnectionAliasState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "DELETING", - "name": "DELETING" - } - ] - } - }, - "com.amazonaws.workspaces#ConnectionIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]+$" - } - }, - "com.amazonaws.workspaces#ConnectionState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CONNECTED", - "name": "CONNECTED" - }, - { - "value": "DISCONNECTED", - "name": "DISCONNECTED" - }, - { - "value": "UNKNOWN", - "name": "UNKNOWN" - } - ] - } - }, - "com.amazonaws.workspaces#ConnectionString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[.0-9a-zA-Z\\-]{1,255}$" - } - }, - "com.amazonaws.workspaces#CopyWorkspaceImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#CopyWorkspaceImageRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#CopyWorkspaceImageResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.workspaces#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.workspaces#ResourceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

    Copies the specified image from the specified Region to the current Region. \n For more information about copying images, see \n \n Copy a Custom WorkSpaces Image.

    \n \n

    In the China (Ningxia) Region, you can copy images only within the same Region.

    \n \n

    In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

    \n \n \n

    Before copying a shared image, be sure to verify that it has been shared from the\n correct Amazon Web Services account. To determine if an image has been shared and to see the \n ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.

    \n     " - } - }, - "com.amazonaws.workspaces#CopyWorkspaceImageRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.workspaces#WorkspaceImageName", - "traits": { - "smithy.api#documentation": "

    The name of the image.

    ", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.workspaces#WorkspaceImageDescription", - "traits": { - "smithy.api#documentation": "

    A description of the image.

    " - } - }, - "SourceImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", - "traits": { - "smithy.api#documentation": "

    The identifier of the source image.

    ", - "smithy.api#required": {} - } - }, - "SourceRegion": { - "target": "com.amazonaws.workspaces#Region", - "traits": { - "smithy.api#documentation": "

    The identifier of the source Region.

    ", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.workspaces#TagList", - "traits": { - "smithy.api#documentation": "

    The tags for the image.

    " - } - } - } - }, - "com.amazonaws.workspaces#CopyWorkspaceImageResult": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", - "traits": { - "smithy.api#documentation": "

    The identifier of the image.

    " - } - } - } - }, - "com.amazonaws.workspaces#CreateConnectClientAddIn": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#CreateConnectClientAddInRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#CreateConnectClientAddInResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.workspaces#ResourceCreationFailedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Creates a client-add-in for Amazon Connect within a directory. You can create only\n one Amazon Connect client add-in within a directory.

    \n \n

    This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.

    " - } - }, - "com.amazonaws.workspaces#CreateConnectClientAddInRequest": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The directory identifier for which to configure the client add-in.

    ", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.workspaces#AddInName", - "traits": { - "smithy.api#documentation": "

    The name of the client add-in.

    ", - "smithy.api#required": {} - } - }, - "URL": { - "target": "com.amazonaws.workspaces#AddInUrl", - "traits": { - "smithy.api#documentation": "

    The endpoint URL of the Amazon Connect client add-in.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#CreateConnectClientAddInResult": { - "type": "structure", - "members": { - "AddInId": { - "target": "com.amazonaws.workspaces#AmazonUuid", - "traits": { - "smithy.api#documentation": "

    The client add-in identifier.

    " - } - } - } - }, - "com.amazonaws.workspaces#CreateConnectionAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#CreateConnectionAliasRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#CreateConnectionAliasResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.workspaces#ResourceLimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

    Creates the specified connection alias for use with cross-Region redirection. For more information, see \n \n Cross-Region Redirection for Amazon WorkSpaces.

    " - } - }, - "com.amazonaws.workspaces#CreateConnectionAliasRequest": { - "type": "structure", - "members": { - "ConnectionString": { - "target": "com.amazonaws.workspaces#ConnectionString", - "traits": { - "smithy.api#documentation": "

    A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com.

    \n \n \n

    After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same \n connection string with a different account, even if you delete all instances of it from the original account. The \n connection string is globally reserved for your account.

    \n     ", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.workspaces#TagList", - "traits": { - "smithy.api#documentation": "

    The tags to associate with the connection alias.

    " - } - } - } - }, - "com.amazonaws.workspaces#CreateConnectionAliasResult": { - "type": "structure", - "members": { - "AliasId": { - "target": "com.amazonaws.workspaces#ConnectionAliasId", - "traits": { - "smithy.api#documentation": "

    The identifier of the connection alias.

    " - } - } - } - }, - "com.amazonaws.workspaces#CreateIpGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#CreateIpGroupRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#CreateIpGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.workspaces#ResourceCreationFailedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceLimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

    Creates an IP access control group.

    \n

    An IP access control group provides you with the ability to control the IP addresses\n from which users are allowed to access their WorkSpaces. To specify the CIDR address\n ranges, add rules to your IP access control group and then associate the group with your\n directory. You can add rules when you create the group or at any time using AuthorizeIpRules.

    \n\n

    There is a default IP access control group associated with your directory. If you don't\n associate an IP access control group with your directory, the default group is used. The\n default group includes a default rule that allows users to access their WorkSpaces from\n anywhere. You cannot modify the default IP access control group for your directory.

    " - } - }, - "com.amazonaws.workspaces#CreateIpGroupRequest": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.workspaces#IpGroupName", - "traits": { - "smithy.api#documentation": "

    The name of the group.

    ", - "smithy.api#required": {} - } - }, - "GroupDesc": { - "target": "com.amazonaws.workspaces#IpGroupDesc", - "traits": { - "smithy.api#documentation": "

    The description of the group.

    " - } - }, - "UserRules": { - "target": "com.amazonaws.workspaces#IpRuleList", - "traits": { - "smithy.api#documentation": "

    The rules to add to the group.

    " - } - }, - "Tags": { - "target": "com.amazonaws.workspaces#TagList", - "traits": { - "smithy.api#documentation": "

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    " - } - } - } - }, - "com.amazonaws.workspaces#CreateIpGroupResult": { - "type": "structure", - "members": { - "GroupId": { - "target": "com.amazonaws.workspaces#IpGroupId", - "traits": { - "smithy.api#documentation": "

    The identifier of the group.

    " - } - } - } - }, - "com.amazonaws.workspaces#CreateTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#CreateTagsRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#CreateTagsResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Creates the specified tags for the specified WorkSpaces resource.

    " - } - }, - "com.amazonaws.workspaces#CreateTagsRequest": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.workspaces#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, IP access control groups, and connection aliases.

    ", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.workspaces#TagList", - "traits": { - "smithy.api#documentation": "

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#CreateTagsResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#CreateUpdatedWorkspaceImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#CreateUpdatedWorkspaceImageRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#CreateUpdatedWorkspaceImageResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.workspaces#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Creates a new updated WorkSpace image based on the specified source image. The \n new updated WorkSpace image has the latest drivers and other updates required by \n the Amazon WorkSpaces components.

    \n \n

    To determine which WorkSpace images need to be updated with the latest Amazon \n WorkSpaces requirements, use \n \n DescribeWorkspaceImages.

    \n \n \n
      \n
    • \n

      Only Windows 10, Windows Sever 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.

      \n
      • \n
    • \n

      Microsoft Windows updates and other application updates are not included \n in the update process.

      \n
      • \n
    • \n

      The source WorkSpace image is not deleted. You can delete the source image after you've \n verified your new updated image and created a new bundle.

      \n
      • \n
    \n     " - } - }, - "com.amazonaws.workspaces#CreateUpdatedWorkspaceImageRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.workspaces#WorkspaceImageName", - "traits": { - "smithy.api#documentation": "

    The name of the new updated WorkSpace image.

    ", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.workspaces#WorkspaceImageDescription", - "traits": { - "smithy.api#documentation": "

    A description of whether updates for the WorkSpace image are available.

    ", - "smithy.api#required": {} - } - }, - "SourceImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", - "traits": { - "smithy.api#documentation": "

    The identifier of the source WorkSpace image.

    ", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.workspaces#TagList", - "traits": { - "smithy.api#documentation": "

    The tags that you want to add to the new updated WorkSpace image.

    \n \n \n

    To add tags at the same time when you're creating the updated image, you must create \n an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.

    \n     " - } - } - } - }, - "com.amazonaws.workspaces#CreateUpdatedWorkspaceImageResult": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", - "traits": { - "smithy.api#documentation": "

    The identifier of the new updated WorkSpace image.

    " - } - } - } - }, - "com.amazonaws.workspaces#CreateWorkspaceBundle": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#CreateWorkspaceBundleRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#CreateWorkspaceBundleResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.workspaces#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.workspaces#ResourceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

    Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see \n \n Create a Custom WorkSpaces Image and Bundle.

    " - } - }, - "com.amazonaws.workspaces#CreateWorkspaceBundleRequest": { - "type": "structure", - "members": { - "BundleName": { - "target": "com.amazonaws.workspaces#WorkspaceBundleName", - "traits": { - "smithy.api#documentation": "

    The name of the bundle.

    ", - "smithy.api#required": {} - } - }, - "BundleDescription": { - "target": "com.amazonaws.workspaces#WorkspaceBundleDescription", - "traits": { - "smithy.api#documentation": "

    The description of the bundle.

    ", - "smithy.api#required": {} - } - }, - "ImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", - "traits": { - "smithy.api#documentation": "

    The identifier of the image that is used to create the bundle.

    ", - "smithy.api#required": {} - } - }, - "ComputeType": { - "target": "com.amazonaws.workspaces#ComputeType", - "traits": { - "smithy.api#required": {} - } - }, - "UserStorage": { - "target": "com.amazonaws.workspaces#UserStorage", - "traits": { - "smithy.api#required": {} - } - }, - "RootStorage": { - "target": "com.amazonaws.workspaces#RootStorage" - }, - "Tags": { - "target": "com.amazonaws.workspaces#TagList", - "traits": { - "smithy.api#documentation": "

    The tags associated with the bundle.

    \n \n \n

    To add tags at the same time when you're creating the bundle, you must create an IAM policy that \n grants your IAM user permissions to use workspaces:CreateTags.

    \n     " - } - } - } - }, - "com.amazonaws.workspaces#CreateWorkspaceBundleResult": { - "type": "structure", - "members": { - "WorkspaceBundle": { - "target": "com.amazonaws.workspaces#WorkspaceBundle" - } - } - }, - "com.amazonaws.workspaces#CreateWorkspaces": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#CreateWorkspacesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#CreateWorkspacesResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceLimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

    Creates one or more WorkSpaces.

    \n

    This operation is asynchronous and returns before the WorkSpaces are created.

    " - } - }, - "com.amazonaws.workspaces#CreateWorkspacesRequest": { - "type": "structure", - "members": { - "Workspaces": { - "target": "com.amazonaws.workspaces#WorkspaceRequestList", - "traits": { - "smithy.api#documentation": "

    The WorkSpaces to create. You can specify up to 25 WorkSpaces.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#CreateWorkspacesResult": { - "type": "structure", - "members": { - "FailedRequests": { - "target": "com.amazonaws.workspaces#FailedCreateWorkspaceRequests", - "traits": { - "smithy.api#documentation": "

    Information about the WorkSpaces that could not be created.

    " - } - }, - "PendingRequests": { - "target": "com.amazonaws.workspaces#WorkspaceList", - "traits": { - "smithy.api#documentation": "

    Information about the WorkSpaces that were created.

    \n

    Because this operation is asynchronous, the identifier returned is not immediately\n available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned\n can be incomplete.

    " - } - } - } - }, - "com.amazonaws.workspaces#DedicatedTenancyCidrRangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange" - } - }, - "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange": { - "type": "string", - "traits": { - "smithy.api#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$))$" - } - }, - "com.amazonaws.workspaces#DedicatedTenancyModificationStateEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] - } - }, - "com.amazonaws.workspaces#DedicatedTenancySupportEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLED", - "name": "ENABLED" - } - ] - } - }, - "com.amazonaws.workspaces#DedicatedTenancySupportResultEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "DISABLED", - "name": "DISABLED" - } - ] - } - }, - "com.amazonaws.workspaces#DefaultOu": { - "type": "string" - }, - "com.amazonaws.workspaces#DefaultWorkspaceCreationProperties": { - "type": "structure", - "members": { - "EnableWorkDocs": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Specifies whether the directory is enabled for Amazon WorkDocs.

    " - } - }, - "EnableInternetAccess": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. \n If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an \n internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address \n Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public \n subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting \n applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, \n see \n Configure a VPC for Amazon WorkSpaces.

    " - } - }, - "DefaultOu": { - "target": "com.amazonaws.workspaces#DefaultOu", - "traits": { - "smithy.api#documentation": "

    The organizational unit (OU) in the directory for the WorkSpace machine accounts.

    " - } - }, - "CustomSecurityGroupId": { - "target": "com.amazonaws.workspaces#SecurityGroupId", - "traits": { - "smithy.api#documentation": "

    The identifier of the default security group to apply to WorkSpaces when they are created. \n For more information, see \n \n Security Groups for Your WorkSpaces.

    " - } - }, - "UserEnabledAsLocalAdministrator": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Specifies whether WorkSpace users are local administrators on their WorkSpaces.

    " - } - }, - "EnableMaintenanceMode": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see\n WorkSpace\n Maintenance.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

    " - } - }, - "com.amazonaws.workspaces#DeleteConnectClientAddIn": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DeleteConnectClientAddInRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DeleteConnectClientAddInResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Deletes a client-add-in for Amazon Connect that is configured within a\n directory.

    " - } - }, - "com.amazonaws.workspaces#DeleteConnectClientAddInRequest": { - "type": "structure", - "members": { - "AddInId": { - "target": "com.amazonaws.workspaces#AmazonUuid", - "traits": { - "smithy.api#documentation": "

    The identifier of the client add-in to delete.

    ", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The directory identifier for which the client add-in is configured.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#DeleteConnectClientAddInResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#DeleteConnectionAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DeleteConnectionAliasRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DeleteConnectionAliasResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceAssociatedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Deletes the specified connection alias. For more information, see \n Cross-Region Redirection for Amazon WorkSpaces.

    \n \n \n

    \n If you will no longer be using a fully qualified domain name (FQDN) as the registration code \n for your WorkSpaces users, you must take certain precautions to prevent potential security issues. \n For more information, see \n \n Security Considerations if You Stop Using Cross-Region Redirection.

    \n     \n \n \n

    To delete a connection alias that has been shared, the shared account must first disassociate the connection alias \n from any directories it has been associated with. Then you must unshare the connection alias from the account it has \n been shared with. You can delete a connection alias only after it is no longer shared with any accounts or \n associated with any directories.

    \n     " - } - }, - "com.amazonaws.workspaces#DeleteConnectionAliasRequest": { - "type": "structure", - "members": { - "AliasId": { - "target": "com.amazonaws.workspaces#ConnectionAliasId", - "traits": { - "smithy.api#documentation": "

    The identifier of the connection alias to delete.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#DeleteConnectionAliasResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#DeleteIpGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DeleteIpGroupRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DeleteIpGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceAssociatedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Deletes the specified IP access control group.

    \n

    You cannot delete an IP access control group that is associated with a directory.

    " - } - }, - "com.amazonaws.workspaces#DeleteIpGroupRequest": { - "type": "structure", - "members": { - "GroupId": { - "target": "com.amazonaws.workspaces#IpGroupId", - "traits": { - "smithy.api#documentation": "

    The identifier of the IP access control group.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#DeleteIpGroupResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#DeleteTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DeleteTagsRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DeleteTagsResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Deletes the specified tags from the specified WorkSpaces resource.

    " - } - }, - "com.amazonaws.workspaces#DeleteTagsRequest": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.workspaces#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, IP access control groups, and connection aliases.

    ", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.workspaces#TagKeyList", - "traits": { - "smithy.api#documentation": "

    The tag keys.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#DeleteTagsResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#DeleteWorkspaceBundle": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DeleteWorkspaceBundleRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DeleteWorkspaceBundleResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceAssociatedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see \n \n Delete a Custom WorkSpaces Bundle or Image.

    " - } - }, - "com.amazonaws.workspaces#DeleteWorkspaceBundleRequest": { - "type": "structure", - "members": { - "BundleId": { - "target": "com.amazonaws.workspaces#BundleId", - "traits": { - "smithy.api#documentation": "

    The identifier of the bundle.

    " - } - } - } - }, - "com.amazonaws.workspaces#DeleteWorkspaceBundleResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#DeleteWorkspaceImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DeleteWorkspaceImageRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DeleteWorkspaceImageResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#ResourceAssociatedException" - } - ], - "traits": { - "smithy.api#documentation": "

    Deletes the specified image from your account. To delete an image, you must first delete\n any bundles that are associated with the image and unshare the image if it is shared with\n other accounts.

    " - } - }, - "com.amazonaws.workspaces#DeleteWorkspaceImageRequest": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", - "traits": { - "smithy.api#documentation": "

    The identifier of the image.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#DeleteWorkspaceImageResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#DeregisterWorkspaceDirectory": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Deregisters the specified directory. This operation is asynchronous \n and returns before the WorkSpace directory is deregistered. If any WorkSpaces are\n registered to this directory, you must remove them before you can deregister the directory.

    \n \n \n

    Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. \n If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 \n consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, \n and you will be charged for this directory as per the \n Directory Service pricing terms.

    \n \n

    To delete empty directories, see \n \n Delete the Directory for Your WorkSpaces. If you delete your \n Simple AD or AD Connector directory, you can always create a new one when you want to start using \n WorkSpaces again.

    \n     " - } - }, - "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryRequest": { - "type": "structure", - "members": { - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The identifier of the directory. If any WorkSpaces are registered to this directory, you must \n remove them before you deregister the directory, or you will receive an OperationNotSupportedException \n error.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#DescribeAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeAccountRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeAccountResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - } - ], - "traits": { - "smithy.api#documentation": "

    Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for\n the specified account.

    " - } - }, - "com.amazonaws.workspaces#DescribeAccountModifications": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeAccountModificationsRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeAccountModificationsResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - } - ], - "traits": { - "smithy.api#documentation": "

    Retrieves a list that describes modifications to the configuration of Bring Your Own\n License (BYOL) for the specified account.

    " - } - }, - "com.amazonaws.workspaces#DescribeAccountModificationsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeAccountModificationsResult": { - "type": "structure", - "members": { - "AccountModifications": { - "target": "com.amazonaws.workspaces#AccountModificationList", - "traits": { - "smithy.api#documentation": "

    The list of modifications to the configuration of BYOL.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there \n are no more results to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeAccountRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#DescribeAccountResult": { - "type": "structure", - "members": { - "DedicatedTenancySupport": { - "target": "com.amazonaws.workspaces#DedicatedTenancySupportResultEnum", - "traits": { - "smithy.api#documentation": "

    The status of BYOL (whether BYOL is enabled or disabled).

    " - } - }, - "DedicatedTenancyManagementCidrRange": { - "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange", - "traits": { - "smithy.api#documentation": "

    The IP address range, specified as an IPv4 CIDR block, used for the management network\n interface.

    \n

    The management network interface is connected to a secure Amazon WorkSpaces management\n network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces\n clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeClientProperties": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeClientPropertiesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeClientPropertiesResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

    " - } - }, - "com.amazonaws.workspaces#DescribeClientPropertiesRequest": { - "type": "structure", - "members": { - "ResourceIds": { - "target": "com.amazonaws.workspaces#ResourceIdList", - "traits": { - "smithy.api#documentation": "

    The resource identifier, in the form of directory IDs.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#DescribeClientPropertiesResult": { - "type": "structure", - "members": { - "ClientPropertiesList": { - "target": "com.amazonaws.workspaces#ClientPropertiesList", - "traits": { - "smithy.api#documentation": "

    Information about the specified Amazon WorkSpaces clients.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeConnectClientAddIns": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeConnectClientAddInsRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeConnectClientAddInsResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Retrieves a list of Amazon Connect client add-ins that have been created.

    " - } - }, - "com.amazonaws.workspaces#DescribeConnectClientAddInsRequest": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The directory identifier for which the client add-in is configured.

    ", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " - } - }, - "MaxResults": { - "target": "com.amazonaws.workspaces#Limit", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeConnectClientAddInsResult": { - "type": "structure", - "members": { - "AddIns": { - "target": "com.amazonaws.workspaces#ConnectClientAddInList", - "traits": { - "smithy.api#documentation": "

    Information about client add-ins.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeConnectionAliasPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeConnectionAliasPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeConnectionAliasPermissionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for \n the specified connection alias. For more information, see \n Cross-Region Redirection for Amazon WorkSpaces.

    " - } - }, - "com.amazonaws.workspaces#DescribeConnectionAliasPermissionsRequest": { - "type": "structure", - "members": { - "AliasId": { - "target": "com.amazonaws.workspaces#ConnectionAliasId", - "traits": { - "smithy.api#documentation": "

    The identifier of the connection alias.

    ", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated, provide this token to receive the \n next set of results.

    " - } - }, - "MaxResults": { - "target": "com.amazonaws.workspaces#Limit", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeConnectionAliasPermissionsResult": { - "type": "structure", - "members": { - "AliasId": { - "target": "com.amazonaws.workspaces#ConnectionAliasId", - "traits": { - "smithy.api#documentation": "

    The identifier of the connection alias.

    " - } - }, - "ConnectionAliasPermissions": { - "target": "com.amazonaws.workspaces#ConnectionAliasPermissions", - "traits": { - "smithy.api#documentation": "

    The permissions associated with a connection alias.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeConnectionAliases": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeConnectionAliasesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeConnectionAliasesResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - } - ], - "traits": { - "smithy.api#documentation": "

    Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see \n \n Cross-Region Redirection for Amazon WorkSpaces.

    " - } - }, - "com.amazonaws.workspaces#DescribeConnectionAliasesRequest": { - "type": "structure", - "members": { - "AliasIds": { - "target": "com.amazonaws.workspaces#ConnectionAliasIdList", - "traits": { - "smithy.api#documentation": "

    The identifiers of the connection aliases to describe.

    " - } - }, - "ResourceId": { - "target": "com.amazonaws.workspaces#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The identifier of the directory associated with the connection alias.

    " - } - }, - "Limit": { - "target": "com.amazonaws.workspaces#Limit", - "traits": { - "smithy.api#documentation": "

    The maximum number of connection aliases to return.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated, provide this token to receive the \n next set of results.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeConnectionAliasesResult": { - "type": "structure", - "members": { - "ConnectionAliases": { - "target": "com.amazonaws.workspaces#ConnectionAliasList", - "traits": { - "smithy.api#documentation": "

    Information about the specified connection aliases.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeIpGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeIpGroupsRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeIpGroupsResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - } - ], - "traits": { - "smithy.api#documentation": "

    Describes one or more of your IP access control groups.

    " - } - }, - "com.amazonaws.workspaces#DescribeIpGroupsRequest": { - "type": "structure", - "members": { - "GroupIds": { - "target": "com.amazonaws.workspaces#IpGroupIdList", - "traits": { - "smithy.api#documentation": "

    The identifiers of one or more IP access control groups.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " - } - }, - "MaxResults": { - "target": "com.amazonaws.workspaces#Limit", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeIpGroupsResult": { - "type": "structure", - "members": { - "Result": { - "target": "com.amazonaws.workspaces#WorkspacesIpGroupsList", - "traits": { - "smithy.api#documentation": "

    Information about the IP access control groups.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeTagsRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeTagsResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Describes the specified tags for the specified WorkSpaces resource.

    " - } - }, - "com.amazonaws.workspaces#DescribeTagsRequest": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.workspaces#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, IP access control groups, and connection aliases.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#DescribeTagsResult": { - "type": "structure", - "members": { - "TagList": { - "target": "com.amazonaws.workspaces#TagList", - "traits": { - "smithy.api#documentation": "

    The tags.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceBundles": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeWorkspaceBundlesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeWorkspaceBundlesResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - } - ], - "traits": { - "smithy.api#documentation": "

    Retrieves a list that describes the available WorkSpace bundles.

    \n

    You can filter the results using either bundle ID or owner, but not both.

    ", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Bundles" - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceBundlesRequest": { - "type": "structure", - "members": { - "BundleIds": { - "target": "com.amazonaws.workspaces#BundleIdList", - "traits": { - "smithy.api#documentation": "

    The identifiers of the bundles. You cannot combine this parameter with any other filter.

    " - } - }, - "Owner": { - "target": "com.amazonaws.workspaces#BundleOwner", - "traits": { - "smithy.api#documentation": "

    The owner of the bundles. You cannot combine this parameter with any other filter.

    \n

    To describe the bundles provided by Amazon Web Services, specify AMAZON. \n To describe the bundles that belong to your account, don't specify a value.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The token for the next set of results. (You received this token from a previous call.)

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceBundlesResult": { - "type": "structure", - "members": { - "Bundles": { - "target": "com.amazonaws.workspaces#BundleList", - "traits": { - "smithy.api#documentation": "

    Information about the bundles.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are no more \n results to return. This token is valid for one day and must be used within that time\n frame.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceDirectories": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeWorkspaceDirectoriesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeWorkspaceDirectoriesResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - } - ], - "traits": { - "smithy.api#documentation": "

    Describes the available directories that are registered with\n Amazon WorkSpaces.

    ", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Directories" - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceDirectoriesRequest": { - "type": "structure", - "members": { - "DirectoryIds": { - "target": "com.amazonaws.workspaces#DirectoryIdList", - "traits": { - "smithy.api#documentation": "

    The identifiers of the directories. If the value is null, all directories are\n retrieved.

    " - } - }, - "Limit": { - "target": "com.amazonaws.workspaces#Limit", - "traits": { - "smithy.api#documentation": "

    The maximum number of directories to return.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceDirectoriesResult": { - "type": "structure", - "members": { - "Directories": { - "target": "com.amazonaws.workspaces#DirectoryList", - "traits": { - "smithy.api#documentation": "

    Information about the directories.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceImagePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeWorkspaceImagePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeWorkspaceImagePermissionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Describes the permissions that the owner of an image has granted to other \n Amazon Web Services accounts for an image.

    " - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceImagePermissionsRequest": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", - "traits": { - "smithy.api#documentation": "

    The identifier of the image.

    ", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated, \n provide this token to receive the next set of results.

    " - } - }, - "MaxResults": { - "target": "com.amazonaws.workspaces#Limit", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceImagePermissionsResult": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", - "traits": { - "smithy.api#documentation": "

    The identifier of the image.

    " - } - }, - "ImagePermissions": { - "target": "com.amazonaws.workspaces#ImagePermissions", - "traits": { - "smithy.api#documentation": "

    The identifiers of the Amazon Web Services accounts that the image has been shared with.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceImages": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeWorkspaceImagesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeWorkspaceImagesResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - } - ], - "traits": { - "smithy.api#documentation": "

    Retrieves a list that describes one or more specified images, if the image identifiers\n are provided. Otherwise, all images in the account are described.

    " - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceImagesRequest": { - "type": "structure", - "members": { - "ImageIds": { - "target": "com.amazonaws.workspaces#WorkspaceImageIdList", - "traits": { - "smithy.api#documentation": "

    The identifier of the image.

    " - } - }, - "ImageType": { - "target": "com.amazonaws.workspaces#ImageType", - "traits": { - "smithy.api#documentation": "

    The type (owned or shared) of the image.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " - } - }, - "MaxResults": { - "target": "com.amazonaws.workspaces#Limit", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceImagesResult": { - "type": "structure", - "members": { - "Images": { - "target": "com.amazonaws.workspaces#WorkspaceImageList", - "traits": { - "smithy.api#documentation": "

    Information about the images.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeWorkspaceSnapshotsRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeWorkspaceSnapshotsResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Describes the snapshots for the specified WorkSpace.

    " - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceSnapshotsRequest": { - "type": "structure", - "members": { - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspaceSnapshotsResult": { - "type": "structure", - "members": { - "RebuildSnapshots": { - "target": "com.amazonaws.workspaces#SnapshotList", - "traits": { - "smithy.api#documentation": "

    Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include\n the user volume.

    " - } - }, - "RestoreSnapshots": { - "target": "com.amazonaws.workspaces#SnapshotList", - "traits": { - "smithy.api#documentation": "

    Information about the snapshots that can be used to restore a WorkSpace. These snapshots\n include both the root volume and the user volume.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspaces": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeWorkspacesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeWorkspacesResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

    Describes the specified WorkSpaces.

    \n

    You can filter the results by using the bundle identifier, directory identifier, or\n owner, but you can specify only one filter at a time.

    ", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Workspaces", - "pageSize": "Limit" - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspacesConnectionStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeWorkspacesConnectionStatusRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeWorkspacesConnectionStatusResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - } - ], - "traits": { - "smithy.api#documentation": "

    Describes the connection status of the specified WorkSpaces.

    " - } - }, - "com.amazonaws.workspaces#DescribeWorkspacesConnectionStatusRequest": { - "type": "structure", - "members": { - "WorkspaceIds": { - "target": "com.amazonaws.workspaces#WorkspaceIdList", - "traits": { - "smithy.api#documentation": "

    The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspacesConnectionStatusResult": { - "type": "structure", - "members": { - "WorkspacesConnectionStatus": { - "target": "com.amazonaws.workspaces#WorkspaceConnectionStatusList", - "traits": { - "smithy.api#documentation": "

    Information about the connection status of the WorkSpace.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspacesRequest": { - "type": "structure", - "members": { - "WorkspaceIds": { - "target": "com.amazonaws.workspaces#WorkspaceIdList", - "traits": { - "smithy.api#documentation": "

    The identifiers of the WorkSpaces. You cannot combine this parameter with any other\n filter.

    \n

    Because the CreateWorkspaces operation is asynchronous, the identifier\n it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

    " - } - }, - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The identifier of the directory. In addition, you can optionally specify a specific\n directory user (see UserName). You cannot combine this parameter with any\n other filter.

    " - } - }, - "UserName": { - "target": "com.amazonaws.workspaces#UserName", - "traits": { - "smithy.api#documentation": "

    The name of the directory user. You must specify this parameter with\n DirectoryId.

    " - } - }, - "BundleId": { - "target": "com.amazonaws.workspaces#BundleId", - "traits": { - "smithy.api#documentation": "

    The identifier of the bundle. All WorkSpaces that are created from this bundle are\n retrieved. You cannot combine this parameter with any other filter.

    " - } - }, - "Limit": { - "target": "com.amazonaws.workspaces#Limit", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " - } - } - } - }, - "com.amazonaws.workspaces#DescribeWorkspacesResult": { - "type": "structure", - "members": { - "Workspaces": { - "target": "com.amazonaws.workspaces#WorkspaceList", - "traits": { - "smithy.api#documentation": "

    Information about the WorkSpaces.

    \n

    Because CreateWorkspaces is an asynchronous operation, some of the\n returned information could be incomplete.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#Description": { - "type": "string" - }, - "com.amazonaws.workspaces#DirectoryId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 10, - "max": 65 - }, - "smithy.api#pattern": "^d-[0-9a-f]{8,63}$" - } - }, - "com.amazonaws.workspaces#DirectoryIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#DirectoryId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#DirectoryList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#WorkspaceDirectory" - } - }, - "com.amazonaws.workspaces#DirectoryName": { - "type": "string" - }, - "com.amazonaws.workspaces#DisassociateConnectionAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DisassociateConnectionAliasRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DisassociateConnectionAliasResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region \n redirection between two directories in different Regions. For more information, see \n \n Cross-Region Redirection for Amazon WorkSpaces.

    \n \n \n

    Before performing this operation, call \n DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

    \n     " - } - }, - "com.amazonaws.workspaces#DisassociateConnectionAliasRequest": { - "type": "structure", - "members": { - "AliasId": { - "target": "com.amazonaws.workspaces#ConnectionAliasId", - "traits": { - "smithy.api#documentation": "

    The identifier of the connection alias to disassociate.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#DisassociateConnectionAliasResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#DisassociateIpGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DisassociateIpGroupsRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DisassociateIpGroupsResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Disassociates the specified IP access control group from the specified directory.

    " - } - }, - "com.amazonaws.workspaces#DisassociateIpGroupsRequest": { - "type": "structure", - "members": { - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The identifier of the directory.

    ", - "smithy.api#required": {} - } - }, - "GroupIds": { - "target": "com.amazonaws.workspaces#IpGroupIdList", - "traits": { - "smithy.api#documentation": "

    The identifiers of one or more IP access control groups.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#DisassociateIpGroupsResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#DnsIpAddresses": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#IpAddress" - } - }, - "com.amazonaws.workspaces#Ec2ImageId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^ami\\-([a-f0-9]{8}|[a-f0-9]{17})$" - } - }, - "com.amazonaws.workspaces#ErrorType": { - "type": "string" - }, - "com.amazonaws.workspaces#ExceptionMessage": { - "type": "string" - }, - "com.amazonaws.workspaces#FailedCreateWorkspaceRequest": { - "type": "structure", - "members": { - "WorkspaceRequest": { - "target": "com.amazonaws.workspaces#WorkspaceRequest", - "traits": { - "smithy.api#documentation": "

    Information about the WorkSpace.

    " - } - }, - "ErrorCode": { - "target": "com.amazonaws.workspaces#ErrorType", - "traits": { - "smithy.api#documentation": "

    The error code that is returned if the WorkSpace cannot be created.

    " - } - }, - "ErrorMessage": { - "target": "com.amazonaws.workspaces#Description", - "traits": { - "smithy.api#documentation": "

    The text of the error message that is returned if the WorkSpace cannot be\n created.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes a WorkSpace that cannot be created.

    " - } - }, - "com.amazonaws.workspaces#FailedCreateWorkspaceRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#FailedCreateWorkspaceRequest" - } - }, - "com.amazonaws.workspaces#FailedRebootWorkspaceRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#FailedWorkspaceChangeRequest" - } - }, - "com.amazonaws.workspaces#FailedRebuildWorkspaceRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#FailedWorkspaceChangeRequest" - } - }, - "com.amazonaws.workspaces#FailedStartWorkspaceRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#FailedWorkspaceChangeRequest" - } - }, - "com.amazonaws.workspaces#FailedStopWorkspaceRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#FailedWorkspaceChangeRequest" - } - }, - "com.amazonaws.workspaces#FailedTerminateWorkspaceRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#FailedWorkspaceChangeRequest" - } - }, - "com.amazonaws.workspaces#FailedWorkspaceChangeRequest": { - "type": "structure", - "members": { - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " - } - }, - "ErrorCode": { - "target": "com.amazonaws.workspaces#ErrorType", - "traits": { - "smithy.api#documentation": "

    The error code that is returned if the WorkSpace cannot be rebooted.

    " - } - }, - "ErrorMessage": { - "target": "com.amazonaws.workspaces#Description", - "traits": { - "smithy.api#documentation": "

    The text of the error message that is returned if the WorkSpace cannot be\n rebooted.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes a WorkSpace that could not be rebooted.\n (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated\n (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).

    " - } - }, - "com.amazonaws.workspaces#ImagePermission": { - "type": "structure", - "members": { - "SharedAccountId": { - "target": "com.amazonaws.workspaces#AwsAccount", - "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Web Services account that an image has been shared with.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes the Amazon Web Services accounts that have been granted permission to use a shared image. \n For more information about sharing images, see \n \n Share or Unshare a Custom WorkSpaces Image.

    " - } - }, - "com.amazonaws.workspaces#ImagePermissions": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#ImagePermission" - } - }, - "com.amazonaws.workspaces#ImageType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OWNED", - "name": "OWNED" - }, - { - "value": "SHARED", - "name": "SHARED" - } - ] - } - }, - "com.amazonaws.workspaces#ImportWorkspaceImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#ImportWorkspaceImageRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#ImportWorkspaceImageResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.workspaces#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon\n WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your \n Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see\n \n Bring Your Own Windows Desktop Licenses.

    " - } - }, - "com.amazonaws.workspaces#ImportWorkspaceImageRequest": { - "type": "structure", - "members": { - "Ec2ImageId": { - "target": "com.amazonaws.workspaces#Ec2ImageId", - "traits": { - "smithy.api#documentation": "

    The identifier of the EC2 image.

    ", - "smithy.api#required": {} - } - }, - "IngestionProcess": { - "target": "com.amazonaws.workspaces#WorkspaceImageIngestionProcess", - "traits": { - "smithy.api#documentation": "

    The ingestion process to be used when importing the image, depending on which protocol \n you want to use for your BYOL Workspace image, either PCoIP or WorkSpaces Streaming Protocol \n (WSP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value \n that does not end in _WSP.

    \n \n

    For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify \n BYOL_REGULAR or BYOL_REGULAR_WSP, depending on the protocol.

    ", - "smithy.api#required": {} - } - }, - "ImageName": { - "target": "com.amazonaws.workspaces#WorkspaceImageName", - "traits": { - "smithy.api#documentation": "

    The name of the WorkSpace image.

    ", - "smithy.api#required": {} - } - }, - "ImageDescription": { - "target": "com.amazonaws.workspaces#WorkspaceImageDescription", - "traits": { - "smithy.api#documentation": "

    The description of the WorkSpace image.

    ", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.workspaces#TagList", - "traits": { - "smithy.api#documentation": "

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    " - } - }, - "Applications": { - "target": "com.amazonaws.workspaces#ApplicationList", - "traits": { - "smithy.api#documentation": "

    If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 \n BYOL images. For more information about subscribing to Office for BYOL images, see \n \n Bring Your Own Windows Desktop Licenses.

    \n \n \n

    Although this parameter is an array, only one item is allowed at this time.

    \n     " - } - } - } - }, - "com.amazonaws.workspaces#ImportWorkspaceImageResult": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace image.

    " - } - } - } - }, - "com.amazonaws.workspaces#InvalidParameterValuesException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage", - "traits": { - "smithy.api#documentation": "

    The exception error message.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    One or more parameter values are not valid.

    ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.workspaces#InvalidResourceStateException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

    The state of the resource is not valid for this operation.

    ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.workspaces#IpAddress": { - "type": "string" - }, - "com.amazonaws.workspaces#IpGroupDesc": { - "type": "string" - }, - "com.amazonaws.workspaces#IpGroupId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^wsipg-[0-9a-z]{8,63}$" - } - }, - "com.amazonaws.workspaces#IpGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#IpGroupId" - } - }, - "com.amazonaws.workspaces#IpGroupName": { - "type": "string" - }, - "com.amazonaws.workspaces#IpRevokedRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#IpRule" - } - }, - "com.amazonaws.workspaces#IpRule": { - "type": "string" - }, - "com.amazonaws.workspaces#IpRuleDesc": { - "type": "string" - }, - "com.amazonaws.workspaces#IpRuleItem": { - "type": "structure", - "members": { - "ipRule": { - "target": "com.amazonaws.workspaces#IpRule", - "traits": { - "smithy.api#documentation": "

    The IP address range, in CIDR notation.

    " - } - }, - "ruleDesc": { - "target": "com.amazonaws.workspaces#IpRuleDesc", - "traits": { - "smithy.api#documentation": "

    The description.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes a rule for an IP access control group.

    " - } - }, - "com.amazonaws.workspaces#IpRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#IpRuleItem" - } - }, - "com.amazonaws.workspaces#Limit": { - "type": "integer", - "traits": { - "smithy.api#box": {}, - "smithy.api#range": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#ListAvailableManagementCidrRanges": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#ListAvailableManagementCidrRangesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#ListAvailableManagementCidrRangesResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - } - ], - "traits": { - "smithy.api#documentation": "

    Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use\n for the network management interface when you enable Bring Your Own License (BYOL).

    \n \n

    This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account \n isn't enabled for BYOL, you'll receive an AccessDeniedException error.

    \n \n

    The management network interface is connected to a secure Amazon WorkSpaces management\n network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces\n clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

    " - } - }, - "com.amazonaws.workspaces#ListAvailableManagementCidrRangesRequest": { - "type": "structure", - "members": { - "ManagementCidrRangeConstraint": { - "target": "com.amazonaws.workspaces#ManagementCidrRangeConstraint", - "traits": { - "smithy.api#documentation": "

    The IP address range to search. Specify an IP address range that is compatible with your\n network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).

    ", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.workspaces#ManagementCidrRangeMaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " - } - } - } - }, - "com.amazonaws.workspaces#ListAvailableManagementCidrRangesResult": { - "type": "structure", - "members": { - "ManagementCidrRanges": { - "target": "com.amazonaws.workspaces#DedicatedTenancyCidrRangeList", - "traits": { - "smithy.api#documentation": "

    The list of available IP address ranges, specified as IPv4 CIDR blocks.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " - } - } - } - }, - "com.amazonaws.workspaces#ManagementCidrRangeConstraint": { - "type": "string", - "traits": { - "smithy.api#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]))$" - } - }, - "com.amazonaws.workspaces#ManagementCidrRangeMaxResults": { - "type": "integer", - "traits": { - "smithy.api#box": {}, - "smithy.api#range": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.workspaces#MigrateWorkspace": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#MigrateWorkspaceRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#MigrateWorkspaceResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#OperationInProgressException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.workspaces#ResourceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

    Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.

    \n \n

    The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume \n from the last available snapshot of the original WorkSpace. During migration, the original D:\\Users\\%USERNAME% \n user profile folder is renamed to D:\\Users\\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\\Users\\%USERNAME%\\ \n folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.

    \n \n

    For available migration scenarios, details about what happens during migration, and best practices, see \n Migrate a WorkSpace.

    " - } - }, - "com.amazonaws.workspaces#MigrateWorkspaceRequest": { - "type": "structure", - "members": { - "SourceWorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace to migrate from.

    ", - "smithy.api#required": {} - } - }, - "BundleId": { - "target": "com.amazonaws.workspaces#BundleId", - "traits": { - "smithy.api#documentation": "

    The identifier of the target bundle type to migrate the WorkSpace to.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#MigrateWorkspaceResult": { - "type": "structure", - "members": { - "SourceWorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The original identifier of the WorkSpace that is being migrated.

    " - } - }, - "TargetWorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, \n the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.

    " - } - } - } - }, - "com.amazonaws.workspaces#ModificationResourceEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ROOT_VOLUME", - "name": "ROOT_VOLUME" - }, - { - "value": "USER_VOLUME", - "name": "USER_VOLUME" - }, - { - "value": "COMPUTE_TYPE", - "name": "COMPUTE_TYPE" - } - ] - } - }, - "com.amazonaws.workspaces#ModificationState": { - "type": "structure", - "members": { - "Resource": { - "target": "com.amazonaws.workspaces#ModificationResourceEnum", - "traits": { - "smithy.api#documentation": "

    The resource.

    " - } - }, - "State": { - "target": "com.amazonaws.workspaces#ModificationStateEnum", - "traits": { - "smithy.api#documentation": "

    The modification state.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes a WorkSpace modification.

    " - } - }, - "com.amazonaws.workspaces#ModificationStateEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UPDATE_INITIATED", - "name": "UPDATE_INITIATED" - }, - { - "value": "UPDATE_IN_PROGRESS", - "name": "UPDATE_IN_PROGRESS" - } - ] - } - }, - "com.amazonaws.workspaces#ModificationStateList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#ModificationState" - } - }, - "com.amazonaws.workspaces#ModifyAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#ModifyAccountRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#ModifyAccountResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.workspaces#ResourceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

    Modifies the configuration of Bring Your Own License (BYOL) for the specified\n account.

    " - } - }, - "com.amazonaws.workspaces#ModifyAccountRequest": { - "type": "structure", - "members": { - "DedicatedTenancySupport": { - "target": "com.amazonaws.workspaces#DedicatedTenancySupportEnum", - "traits": { - "smithy.api#documentation": "

    The status of BYOL.

    " - } - }, - "DedicatedTenancyManagementCidrRange": { - "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange", - "traits": { - "smithy.api#documentation": "

    The IP address range, specified as an IPv4 CIDR block, for the management network\n interface. Specify an IP address range that is compatible with your network and in CIDR\n notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be\n /16 (for example, 203.0.113.25/16). It must also be specified as available by the\n ListAvailableManagementCidrRanges operation.

    " - } - } - } - }, - "com.amazonaws.workspaces#ModifyAccountResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#ModifyClientProperties": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#ModifyClientPropertiesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#ModifyClientPropertiesResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Modifies the properties of the specified Amazon WorkSpaces clients.

    " - } - }, - "com.amazonaws.workspaces#ModifyClientPropertiesRequest": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.workspaces#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The resource identifiers, in the form of directory IDs.

    ", - "smithy.api#required": {} - } - }, - "ClientProperties": { - "target": "com.amazonaws.workspaces#ClientProperties", - "traits": { - "smithy.api#documentation": "

    Information about the Amazon WorkSpaces client.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#ModifyClientPropertiesResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#ModifySelfservicePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#ModifySelfservicePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#ModifySelfservicePermissionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Modifies the self-service WorkSpace management capabilities for your users. For more\n information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

    " - } - }, - "com.amazonaws.workspaces#ModifySelfservicePermissionsRequest": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The identifier of the directory.

    ", - "smithy.api#required": {} - } - }, - "SelfservicePermissions": { - "target": "com.amazonaws.workspaces#SelfservicePermissions", - "traits": { - "smithy.api#documentation": "

    The permissions to enable or disable self-service capabilities.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#ModifySelfservicePermissionsResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#ModifyWorkspaceAccessProperties": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#ModifyWorkspaceAccessPropertiesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#ModifyWorkspaceAccessPropertiesResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Specifies which devices and operating systems users can use to access their WorkSpaces.\n For more information, see \n Control Device Access.

    " - } - }, - "com.amazonaws.workspaces#ModifyWorkspaceAccessPropertiesRequest": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The identifier of the directory.

    ", - "smithy.api#required": {} - } - }, - "WorkspaceAccessProperties": { - "target": "com.amazonaws.workspaces#WorkspaceAccessProperties", - "traits": { - "smithy.api#documentation": "

    The device types and operating systems to enable or disable for access.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#ModifyWorkspaceAccessPropertiesResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#ModifyWorkspaceCreationProperties": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#ModifyWorkspaceCreationPropertiesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#ModifyWorkspaceCreationPropertiesResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Modify the default properties used to create WorkSpaces.

    " - } - }, - "com.amazonaws.workspaces#ModifyWorkspaceCreationPropertiesRequest": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The identifier of the directory.

    ", - "smithy.api#required": {} - } - }, - "WorkspaceCreationProperties": { - "target": "com.amazonaws.workspaces#WorkspaceCreationProperties", - "traits": { - "smithy.api#documentation": "

    The default properties for creating WorkSpaces.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#ModifyWorkspaceCreationPropertiesResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#ModifyWorkspaceProperties": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#ModifyWorkspacePropertiesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#ModifyWorkspacePropertiesResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#OperationInProgressException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.workspaces#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.workspaces#UnsupportedWorkspaceConfigurationException" - } - ], - "traits": { - "smithy.api#documentation": "

    Modifies the specified WorkSpace properties. For important information about how \n to modify the size of the root and user volumes, see \n \n Modify a WorkSpace.\n

    " - } - }, - "com.amazonaws.workspaces#ModifyWorkspacePropertiesRequest": { - "type": "structure", - "members": { - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", - "smithy.api#required": {} - } - }, - "WorkspaceProperties": { - "target": "com.amazonaws.workspaces#WorkspaceProperties", - "traits": { - "smithy.api#documentation": "

    The properties of the WorkSpace.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#ModifyWorkspacePropertiesResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#ModifyWorkspaceState": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#ModifyWorkspaceStateRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#ModifyWorkspaceStateResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Sets the state of the specified WorkSpace.

    \n

    To maintain a WorkSpace without being interrupted, set the WorkSpace state to\n ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to\n reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not\n stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE\n state.

    " - } - }, - "com.amazonaws.workspaces#ModifyWorkspaceStateRequest": { - "type": "structure", - "members": { - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", - "smithy.api#required": {} - } - }, - "WorkspaceState": { - "target": "com.amazonaws.workspaces#TargetWorkspaceState", - "traits": { - "smithy.api#documentation": "

    The WorkSpace state.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#ModifyWorkspaceStateResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.workspaces#OperatingSystem": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.workspaces#OperatingSystemType", - "traits": { - "smithy.api#documentation": "

    The operating system.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    The operating system that the image is running.

    " - } - }, - "com.amazonaws.workspaces#OperatingSystemType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "WINDOWS", - "name": "WINDOWS" - }, - { - "value": "LINUX", - "name": "LINUX" - } - ] - } - }, - "com.amazonaws.workspaces#OperationInProgressException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

    The properties of this WorkSpace are currently being modified. Try again in a moment.

    ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.workspaces#OperationNotSupportedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

    This operation is not supported.

    ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.workspaces#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.workspaces#RebootRequest": { - "type": "structure", - "members": { - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes the information used to reboot a WorkSpace.

    " - } - }, - "com.amazonaws.workspaces#RebootWorkspaceRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#RebootRequest" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#RebootWorkspaces": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#RebootWorkspacesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#RebootWorkspacesResult" - }, - "traits": { - "smithy.api#documentation": "

    Reboots the specified WorkSpaces.

    \n

    You cannot reboot a WorkSpace unless its state is AVAILABLE or\n UNHEALTHY.

    \n

    This operation is asynchronous and returns before the WorkSpaces have rebooted.

    " - } - }, - "com.amazonaws.workspaces#RebootWorkspacesRequest": { - "type": "structure", - "members": { - "RebootWorkspaceRequests": { - "target": "com.amazonaws.workspaces#RebootWorkspaceRequests", - "traits": { - "smithy.api#documentation": "

    The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#RebootWorkspacesResult": { - "type": "structure", - "members": { - "FailedRequests": { - "target": "com.amazonaws.workspaces#FailedRebootWorkspaceRequests", - "traits": { - "smithy.api#documentation": "

    Information about the WorkSpaces that could not be rebooted.

    " - } - } - } - }, - "com.amazonaws.workspaces#RebuildRequest": { - "type": "structure", - "members": { - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes the information used to rebuild a WorkSpace.

    " - } - }, - "com.amazonaws.workspaces#RebuildWorkspaceRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#RebuildRequest" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.workspaces#RebuildWorkspaces": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#RebuildWorkspacesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#RebuildWorkspacesResult" - }, - "traits": { - "smithy.api#documentation": "

    Rebuilds the specified WorkSpace.

    \n

    You cannot rebuild a WorkSpace unless its state is AVAILABLE,\n ERROR, UNHEALTHY, STOPPED, or REBOOTING.

    \n

    Rebuilding a WorkSpace is a potentially destructive action that can result in the loss\n of data. For more information, see Rebuild a\n WorkSpace.

    \n

    This operation is asynchronous and returns before the WorkSpaces have been completely\n rebuilt.

    " - } - }, - "com.amazonaws.workspaces#RebuildWorkspacesRequest": { - "type": "structure", - "members": { - "RebuildWorkspaceRequests": { - "target": "com.amazonaws.workspaces#RebuildWorkspaceRequests", - "traits": { - "smithy.api#documentation": "

    The WorkSpace to rebuild. You can specify a single WorkSpace.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#RebuildWorkspacesResult": { - "type": "structure", - "members": { - "FailedRequests": { - "target": "com.amazonaws.workspaces#FailedRebuildWorkspaceRequests", - "traits": { - "smithy.api#documentation": "

    Information about the WorkSpace that could not be rebuilt.

    " - } - } - } - }, - "com.amazonaws.workspaces#ReconnectEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "DISABLED", - "name": "DISABLED" - } - ] - } - }, - "com.amazonaws.workspaces#Region": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 31 - }, - "smithy.api#pattern": "^[-0-9a-z]{1,31}$" - } - }, - "com.amazonaws.workspaces#RegisterWorkspaceDirectory": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#RegisterWorkspaceDirectoryRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#RegisterWorkspaceDirectoryResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.workspaces#UnsupportedNetworkConfigurationException" - }, - { - "target": "com.amazonaws.workspaces#WorkspacesDefaultRoleNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Registers the specified directory. This operation is asynchronous \n and returns before the WorkSpace directory is registered. If this is the first time you are \n registering a directory, you will need to create the workspaces_DefaultRole role before you can \n register a directory. For more information, see \n Creating the workspaces_DefaultRole Role.

    " - } - }, - "com.amazonaws.workspaces#RegisterWorkspaceDirectoryRequest": { - "type": "structure", - "members": { - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The identifier of the directory. You cannot register a directory if it does not have a status \n of Active. If the directory does not have a status of Active, you will receive an \n InvalidResourceStateException error. If you have already registered the maximum number of directories \n that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. \n Deregister directories that you are not using for WorkSpaces, and try again.

    ", - "smithy.api#required": {} - } - }, - "SubnetIds": { - "target": "com.amazonaws.workspaces#SubnetIds", - "traits": { - "smithy.api#documentation": "

    The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets \n are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these \n conditions are not met, you will receive an OperationNotSupportedException error.

    " - } - }, - "EnableWorkDocs": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and \n WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set \n EnableWorkDocs to disabled, and try again.

    ", - "smithy.api#required": {} - } - }, - "EnableSelfService": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Indicates whether self-service capabilities are enabled or disabled.

    " - } - }, - "Tenancy": { - "target": "com.amazonaws.workspaces#Tenancy", - "traits": { - "smithy.api#documentation": "

    Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own\n License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be \n enabled for BYOL. If your account has not been enabled for BYOL, you will receive an \n InvalidParameterValuesException error. For more information about BYOL images, see\n Bring Your Own Windows Desktop Images.

    " - } - }, - "Tags": { - "target": "com.amazonaws.workspaces#TagList", - "traits": { - "smithy.api#documentation": "

    The tags associated with the directory.

    " - } - } - } - }, - "com.amazonaws.workspaces#RegisterWorkspaceDirectoryResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#RegistrationCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.workspaces#ResourceAlreadyExistsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

    The specified resource already exists.

    ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.workspaces#ResourceAssociatedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

    The resource is associated with a directory.

    ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.workspaces#ResourceCreationFailedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

    The resource could not be created.

    ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.workspaces#ResourceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#NonEmptyString" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#ResourceLimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage", - "traits": { - "smithy.api#documentation": "

    The exception error message.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Your resource limits have been exceeded.

    ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.workspaces#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage", - "traits": { - "smithy.api#documentation": "

    The resource could not be found.

    " - } - }, - "ResourceId": { - "target": "com.amazonaws.workspaces#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The ID of the resource that could not be found.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    The resource could not be found.

    ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.workspaces#ResourceUnavailableException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage", - "traits": { - "smithy.api#documentation": "

    The exception error message.

    " - } - }, - "ResourceId": { - "target": "com.amazonaws.workspaces#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The identifier of the resource that is not available.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    The specified resource is not available.

    ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.workspaces#RestoreWorkspace": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#RestoreWorkspaceRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#RestoreWorkspaceResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Restores the specified WorkSpace to its last known healthy state.

    \n

    You cannot restore a WorkSpace unless its state is AVAILABLE,\n ERROR, UNHEALTHY, or STOPPED.

    \n

    Restoring a WorkSpace is a potentially destructive action that can result in the loss of\n data. For more information, see Restore a\n WorkSpace.

    \n

    This operation is asynchronous and returns before the WorkSpace is completely\n restored.

    " - } - }, - "com.amazonaws.workspaces#RestoreWorkspaceRequest": { - "type": "structure", - "members": { - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#RestoreWorkspaceResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#RevokeIpRules": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#RevokeIpRulesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#RevokeIpRulesResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Removes one or more rules from the specified IP access control group.

    " - } - }, - "com.amazonaws.workspaces#RevokeIpRulesRequest": { - "type": "structure", - "members": { - "GroupId": { - "target": "com.amazonaws.workspaces#IpGroupId", - "traits": { - "smithy.api#documentation": "

    The identifier of the group.

    ", - "smithy.api#required": {} - } - }, - "UserRules": { - "target": "com.amazonaws.workspaces#IpRevokedRuleList", - "traits": { - "smithy.api#documentation": "

    The rules to remove from the group.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#RevokeIpRulesResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#RootStorage": { - "type": "structure", - "members": { - "Capacity": { - "target": "com.amazonaws.workspaces#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The size of the root volume.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes the root volume for a WorkSpace bundle.

    " - } - }, - "com.amazonaws.workspaces#RootVolumeSizeGib": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } - }, - "com.amazonaws.workspaces#RunningMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AUTO_STOP", - "name": "AUTO_STOP" - }, - { - "value": "ALWAYS_ON", - "name": "ALWAYS_ON" - } - ] - } - }, - "com.amazonaws.workspaces#RunningModeAutoStopTimeoutInMinutes": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } - }, - "com.amazonaws.workspaces#SecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 11, - "max": 20 - }, - "smithy.api#pattern": "^(sg-([0-9a-f]{8}|[0-9a-f]{17}))$" - } - }, - "com.amazonaws.workspaces#SelfservicePermissions": { - "type": "structure", - "members": { - "RestartWorkspace": { - "target": "com.amazonaws.workspaces#ReconnectEnum", - "traits": { - "smithy.api#documentation": "

    Specifies whether users can restart their WorkSpace.

    " - } - }, - "IncreaseVolumeSize": { - "target": "com.amazonaws.workspaces#ReconnectEnum", - "traits": { - "smithy.api#documentation": "

    Specifies whether users can increase the volume size of the drives on their\n WorkSpace.

    " - } - }, - "ChangeComputeType": { - "target": "com.amazonaws.workspaces#ReconnectEnum", - "traits": { - "smithy.api#documentation": "

    Specifies whether users can change the compute type (bundle) for their WorkSpace.

    " - } - }, - "SwitchRunningMode": { - "target": "com.amazonaws.workspaces#ReconnectEnum", - "traits": { - "smithy.api#documentation": "

    Specifies whether users can switch the running mode of their WorkSpace.

    " - } - }, - "RebuildWorkspace": { - "target": "com.amazonaws.workspaces#ReconnectEnum", - "traits": { - "smithy.api#documentation": "

    Specifies whether users can rebuild the operating system of a WorkSpace to its original\n state.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

    " - } - }, - "com.amazonaws.workspaces#Snapshot": { - "type": "structure", - "members": { - "SnapshotTime": { - "target": "com.amazonaws.workspaces#Timestamp", - "traits": { - "smithy.api#documentation": "

    The time when the snapshot was created.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes a snapshot.

    " - } - }, - "com.amazonaws.workspaces#SnapshotList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#Snapshot" - } - }, - "com.amazonaws.workspaces#StartRequest": { - "type": "structure", - "members": { - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Information used to start a WorkSpace.

    " - } - }, - "com.amazonaws.workspaces#StartWorkspaceRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#StartRequest" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#StartWorkspaces": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#StartWorkspacesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#StartWorkspacesResult" - }, - "traits": { - "smithy.api#documentation": "

    Starts the specified WorkSpaces.

    \n

    You cannot start a WorkSpace unless it has a running mode of AutoStop and a\n state of STOPPED.

    " - } - }, - "com.amazonaws.workspaces#StartWorkspacesRequest": { - "type": "structure", - "members": { - "StartWorkspaceRequests": { - "target": "com.amazonaws.workspaces#StartWorkspaceRequests", - "traits": { - "smithy.api#documentation": "

    The WorkSpaces to start. You can specify up to 25 WorkSpaces.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#StartWorkspacesResult": { - "type": "structure", - "members": { - "FailedRequests": { - "target": "com.amazonaws.workspaces#FailedStartWorkspaceRequests", - "traits": { - "smithy.api#documentation": "

    Information about the WorkSpaces that could not be started.

    " - } - } - } - }, - "com.amazonaws.workspaces#StopRequest": { - "type": "structure", - "members": { - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes the information used to stop a WorkSpace.

    " - } - }, - "com.amazonaws.workspaces#StopWorkspaceRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#StopRequest" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#StopWorkspaces": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#StopWorkspacesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#StopWorkspacesResult" - }, - "traits": { - "smithy.api#documentation": "

    Stops the specified WorkSpaces.

    \n

    You cannot stop a WorkSpace unless it has a running mode of AutoStop and a\n state of AVAILABLE, IMPAIRED, UNHEALTHY, or\n ERROR.

    " - } - }, - "com.amazonaws.workspaces#StopWorkspacesRequest": { - "type": "structure", - "members": { - "StopWorkspaceRequests": { - "target": "com.amazonaws.workspaces#StopWorkspaceRequests", - "traits": { - "smithy.api#documentation": "

    The WorkSpaces to stop. You can specify up to 25 WorkSpaces.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#StopWorkspacesResult": { - "type": "structure", - "members": { - "FailedRequests": { - "target": "com.amazonaws.workspaces#FailedStopWorkspaceRequests", - "traits": { - "smithy.api#documentation": "

    Information about the WorkSpaces that could not be stopped.

    " - } - } - } - }, - "com.amazonaws.workspaces#SubnetId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 15, - "max": 24 - }, - "smithy.api#pattern": "^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$" - } - }, - "com.amazonaws.workspaces#SubnetIds": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#SubnetId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.workspaces#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.workspaces#TagKey", - "traits": { - "smithy.api#documentation": "

    The key of the tag.

    ", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.workspaces#TagValue", - "traits": { - "smithy.api#documentation": "

    The value of the tag.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes a tag.

    " - } - }, - "com.amazonaws.workspaces#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 127 - } - } - }, - "com.amazonaws.workspaces#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#NonEmptyString" - } - }, - "com.amazonaws.workspaces#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#Tag" - } - }, - "com.amazonaws.workspaces#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.workspaces#TargetWorkspaceState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "ADMIN_MAINTENANCE", - "name": "ADMIN_MAINTENANCE" - } - ] - } - }, - "com.amazonaws.workspaces#Tenancy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DEDICATED", - "name": "DEDICATED" - }, - { - "value": "SHARED", - "name": "SHARED" - } - ] - } - }, - "com.amazonaws.workspaces#TerminateRequest": { - "type": "structure", - "members": { - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes the information used to terminate a WorkSpace.

    " - } - }, - "com.amazonaws.workspaces#TerminateWorkspaceRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#TerminateRequest" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#TerminateWorkspaces": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#TerminateWorkspacesRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#TerminateWorkspacesResult" - }, - "traits": { - "smithy.api#documentation": "

    Terminates the specified WorkSpaces.

    \n \n \n

    Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is\n destroyed. If you need to archive any user data, contact Amazon Web Services Support before\n terminating the WorkSpace.

    \n     \n\n

    You can terminate a WorkSpace that is in any state except SUSPENDED.

    \n

    This operation is asynchronous and returns before the WorkSpaces have been completely\n terminated. After a WorkSpace is terminated, the TERMINATED state is returned \n only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely \n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using \n \n DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has \n been successfully terminated.

    \n \n \n

    Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. \n If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 \n consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, \n and you will be charged for this directory as per the \n Directory Service pricing terms.

    \n \n

    To delete empty directories, see \n \n Delete the Directory for Your WorkSpaces. If you delete your \n Simple AD or AD Connector directory, you can always create a new one when you want to start using \n WorkSpaces again.

    \n     " - } - }, - "com.amazonaws.workspaces#TerminateWorkspacesRequest": { - "type": "structure", - "members": { - "TerminateWorkspaceRequests": { - "target": "com.amazonaws.workspaces#TerminateWorkspaceRequests", - "traits": { - "smithy.api#documentation": "

    The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#TerminateWorkspacesResult": { - "type": "structure", - "members": { - "FailedRequests": { - "target": "com.amazonaws.workspaces#FailedTerminateWorkspaceRequests", - "traits": { - "smithy.api#documentation": "

    Information about the WorkSpaces that could not be terminated.

    " - } - } - } - }, - "com.amazonaws.workspaces#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.workspaces#UnsupportedNetworkConfigurationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

    The configuration of this network is not supported for this operation, or your network configuration \n conflicts with the Amazon WorkSpaces management network IP range. For more information, see \n \n Configure a VPC for Amazon WorkSpaces.

    ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.workspaces#UnsupportedWorkspaceConfigurationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

    The configuration of this WorkSpace is not supported for this operation. For more information, see \n Required \n Configuration and Service Components for WorkSpaces .

    ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.workspaces#UpdateConnectClientAddIn": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#UpdateConnectClientAddInRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#UpdateConnectClientAddInResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Updates a Amazon Connect client add-in. Use this action to update the name and\n endpoint URL of a Amazon Connect client add-in.

    " - } - }, - "com.amazonaws.workspaces#UpdateConnectClientAddInRequest": { - "type": "structure", - "members": { - "AddInId": { - "target": "com.amazonaws.workspaces#AmazonUuid", - "traits": { - "smithy.api#documentation": "

    The identifier of the client add-in to update.

    ", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The directory identifier for which the client add-in is configured.

    ", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.workspaces#AddInName", - "traits": { - "smithy.api#documentation": "

    The name of the client add-in.

    " - } - }, - "URL": { - "target": "com.amazonaws.workspaces#AddInUrl", - "traits": { - "smithy.api#documentation": "

    The endpoint URL of the Amazon Connect client add-in.

    " - } - } - } - }, - "com.amazonaws.workspaces#UpdateConnectClientAddInResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#UpdateConnectionAliasPermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#UpdateConnectionAliasPermissionRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#UpdateConnectionAliasPermissionResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceAssociatedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Shares or unshares a connection alias with one account by specifying whether that account has permission to \n associate the connection alias with a directory. If the association permission is granted, the connection alias \n is shared with that account. If the association permission is revoked, the connection alias is unshared with the \n account. For more information, see \n Cross-Region Redirection for Amazon WorkSpaces.

    \n \n \n
      \n
    • \n

      Before performing this operation, call \n DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

      \n
      • \n
    • \n

      To delete a connection alias that has been shared, the shared account must first disassociate the \n connection alias from any directories it has been associated with. Then you must unshare the connection \n alias from the account it has been shared with. You can delete a connection alias only after it is no \n longer shared with any accounts or associated with any directories.

      \n
      • \n
    \n     " - } - }, - "com.amazonaws.workspaces#UpdateConnectionAliasPermissionRequest": { - "type": "structure", - "members": { - "AliasId": { - "target": "com.amazonaws.workspaces#ConnectionAliasId", - "traits": { - "smithy.api#documentation": "

    The identifier of the connection alias that you want to update permissions for.

    ", - "smithy.api#required": {} - } - }, - "ConnectionAliasPermission": { - "target": "com.amazonaws.workspaces#ConnectionAliasPermission", - "traits": { - "smithy.api#documentation": "

    Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#UpdateConnectionAliasPermissionResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#UpdateDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_./() -]+$" - } - }, - "com.amazonaws.workspaces#UpdateResult": { - "type": "structure", - "members": { - "UpdateAvailable": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Indicates whether updated drivers or other components are available for the specified WorkSpace image.

    " - } - }, - "Description": { - "target": "com.amazonaws.workspaces#UpdateDescription", - "traits": { - "smithy.api#documentation": "

    A description of whether updates for the WorkSpace image are pending or available.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes whether a WorkSpace image needs to be updated with the latest \n drivers and other components required by Amazon WorkSpaces.

    \n \n \n

    Only Windows 10 WorkSpace images can be programmatically updated at this time.

    \n     " - } - }, - "com.amazonaws.workspaces#UpdateRulesOfIpGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#UpdateRulesOfIpGroupRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#UpdateRulesOfIpGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, - { - "target": "com.amazonaws.workspaces#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

    Replaces the current rules of the specified IP access control group with the specified\n rules.

    " - } - }, - "com.amazonaws.workspaces#UpdateRulesOfIpGroupRequest": { - "type": "structure", - "members": { - "GroupId": { - "target": "com.amazonaws.workspaces#IpGroupId", - "traits": { - "smithy.api#documentation": "

    The identifier of the group.

    ", - "smithy.api#required": {} - } - }, - "UserRules": { - "target": "com.amazonaws.workspaces#IpRuleList", - "traits": { - "smithy.api#documentation": "

    One or more rules.

    ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#UpdateRulesOfIpGroupResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#UpdateWorkspaceBundle": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#UpdateWorkspaceBundleRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#UpdateWorkspaceBundleResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.workspaces#ResourceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

    Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see \n \n Update a Custom WorkSpaces Bundle.

    \n \n \n

    Existing WorkSpaces aren't automatically updated when you update the bundle that they're \n based on. To update existing WorkSpaces that are based on a bundle that you've updated, you \n must either rebuild the WorkSpaces or delete and recreate them.

    \n     " - } - }, - "com.amazonaws.workspaces#UpdateWorkspaceBundleRequest": { - "type": "structure", - "members": { - "BundleId": { - "target": "com.amazonaws.workspaces#BundleId", - "traits": { - "smithy.api#documentation": "

    The identifier of the bundle.

    " - } - }, - "ImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", - "traits": { - "smithy.api#documentation": "

    The identifier of the image.

    " - } - } - } - }, - "com.amazonaws.workspaces#UpdateWorkspaceBundleResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#UpdateWorkspaceImagePermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#UpdateWorkspaceImagePermissionRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#UpdateWorkspaceImagePermissionResult" - }, - "errors": [ - { - "target": "com.amazonaws.workspaces#AccessDeniedException" - }, - { - "target": "com.amazonaws.workspaces#InvalidParameterValuesException" - }, - { - "target": "com.amazonaws.workspaces#OperationNotSupportedException" - }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.workspaces#ResourceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

    Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has \n permission to copy the image. If the copy image permission is granted, the image is shared with that account. \n If the copy image permission is revoked, the image is unshared with the account.

    \n \n

    After an image has been shared, the recipient account can copy the image to other Regions as needed.

    \n \n

    In the China (Ningxia) Region, you can copy images only within the same Region.

    \n \n

    In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

    \n \n

    For more information about sharing images, see \n \n Share or Unshare a Custom WorkSpaces Image.

    \n \n \n
      \n
    • \n

      To delete an image that has been shared, you must unshare the image before you delete it.

      \n
      • \n
    • \n

      Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at \n this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in \n Amazon Web Services GovCloud (US), contact Amazon Web Services Support.

      \n
      • \n
    \n     " - } - }, - "com.amazonaws.workspaces#UpdateWorkspaceImagePermissionRequest": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", - "traits": { - "smithy.api#documentation": "

    The identifier of the image.

    ", - "smithy.api#required": {} - } - }, - "AllowCopyImage": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    The permission to copy the image. This permission can be revoked only after an image \n has been shared.

    ", - "smithy.api#required": {} - } - }, - "SharedAccountId": { - "target": "com.amazonaws.workspaces#AwsAccount", - "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Web Services account to share or unshare the image with.

    \n \n \n

    Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.

    \n     ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.workspaces#UpdateWorkspaceImagePermissionResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workspaces#UserName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - } - } - }, - "com.amazonaws.workspaces#UserStorage": { - "type": "structure", - "members": { - "Capacity": { - "target": "com.amazonaws.workspaces#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The size of the user volume.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes the user volume for a WorkSpace bundle.

    " - } - }, - "com.amazonaws.workspaces#UserVolumeSizeGib": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } - }, - "com.amazonaws.workspaces#VolumeEncryptionKey": { - "type": "string" - }, - "com.amazonaws.workspaces#Workspace": { - "type": "structure", - "members": { - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " - } - }, - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The identifier of the Directory Service directory for the WorkSpace.

    " - } - }, - "UserName": { - "target": "com.amazonaws.workspaces#UserName", - "traits": { - "smithy.api#documentation": "

    The user for the WorkSpace.

    " - } - }, - "IpAddress": { - "target": "com.amazonaws.workspaces#IpAddress", - "traits": { - "smithy.api#documentation": "

    The IP address of the WorkSpace.

    " - } - }, - "State": { - "target": "com.amazonaws.workspaces#WorkspaceState", - "traits": { - "smithy.api#documentation": "

    The operational state of the WorkSpace.

    \n \n \n

    After a WorkSpace is terminated, the TERMINATED state is returned \n only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely \n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using \n \n DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has \n been successfully terminated.

    \n     " - } - }, - "BundleId": { - "target": "com.amazonaws.workspaces#BundleId", - "traits": { - "smithy.api#documentation": "

    The identifier of the bundle used to create the WorkSpace.

    " - } - }, - "SubnetId": { - "target": "com.amazonaws.workspaces#SubnetId", - "traits": { - "smithy.api#documentation": "

    The identifier of the subnet for the WorkSpace.

    " - } - }, - "ErrorMessage": { - "target": "com.amazonaws.workspaces#Description", - "traits": { - "smithy.api#documentation": "

    The text of the error message that is returned if the WorkSpace cannot be\n created.

    " - } - }, - "ErrorCode": { - "target": "com.amazonaws.workspaces#WorkspaceErrorCode", - "traits": { - "smithy.api#documentation": "

    The error code that is returned if the WorkSpace cannot be created.

    " - } - }, - "ComputerName": { - "target": "com.amazonaws.workspaces#ComputerName", - "traits": { - "smithy.api#documentation": "

    The name of the WorkSpace, as seen by the operating system. The format of this name varies. \n For more information, see \n Launch a WorkSpace.

    " - } - }, - "VolumeEncryptionKey": { - "target": "com.amazonaws.workspaces#VolumeEncryptionKey", - "traits": { - "smithy.api#documentation": "

    The symmetric KMS key used to encrypt data stored on your WorkSpace. \n Amazon WorkSpaces does not support asymmetric KMS keys.

    " - } - }, - "UserVolumeEncryptionEnabled": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Indicates whether the data stored on the user volume is encrypted.

    " - } - }, - "RootVolumeEncryptionEnabled": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Indicates whether the data stored on the root volume is encrypted.

    " - } - }, - "WorkspaceProperties": { - "target": "com.amazonaws.workspaces#WorkspaceProperties", - "traits": { - "smithy.api#documentation": "

    The properties of the WorkSpace.

    " - } - }, - "ModificationStates": { - "target": "com.amazonaws.workspaces#ModificationStateList", - "traits": { - "smithy.api#documentation": "

    The modification states of the WorkSpace.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes a WorkSpace.

    " - } - }, - "com.amazonaws.workspaces#WorkspaceAccessProperties": { - "type": "structure", - "members": { - "DeviceTypeWindows": { - "target": "com.amazonaws.workspaces#AccessPropertyValue", - "traits": { - "smithy.api#documentation": "

    Indicates whether users can use Windows clients to access their WorkSpaces.

    " - } - }, - "DeviceTypeOsx": { - "target": "com.amazonaws.workspaces#AccessPropertyValue", - "traits": { - "smithy.api#documentation": "

    Indicates whether users can use macOS clients to access their WorkSpaces.

    " - } - }, - "DeviceTypeWeb": { - "target": "com.amazonaws.workspaces#AccessPropertyValue", - "traits": { - "smithy.api#documentation": "

    Indicates whether users can access their WorkSpaces through a web browser.

    " - } - }, - "DeviceTypeIos": { - "target": "com.amazonaws.workspaces#AccessPropertyValue", - "traits": { - "smithy.api#documentation": "

    Indicates whether users can use iOS devices to access their WorkSpaces.

    " - } - }, - "DeviceTypeAndroid": { - "target": "com.amazonaws.workspaces#AccessPropertyValue", - "traits": { - "smithy.api#documentation": "

    Indicates whether users can use Android and Android-compatible Chrome OS devices \n to access their WorkSpaces.

    " - } - }, - "DeviceTypeChromeOs": { - "target": "com.amazonaws.workspaces#AccessPropertyValue", - "traits": { - "smithy.api#documentation": "

    Indicates whether users can use Chromebooks to access their WorkSpaces.

    " - } - }, - "DeviceTypeZeroClient": { - "target": "com.amazonaws.workspaces#AccessPropertyValue", - "traits": { - "smithy.api#documentation": "

    Indicates whether users can use zero client devices to access their WorkSpaces.

    " - } - }, - "DeviceTypeLinux": { - "target": "com.amazonaws.workspaces#AccessPropertyValue", - "traits": { - "smithy.api#documentation": "

    Indicates whether users can use Linux clients to access their WorkSpaces.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    The device types and operating systems that can be used to access a WorkSpace. For more\n information, see Amazon\n WorkSpaces Client Network Requirements.

    " - } - }, - "com.amazonaws.workspaces#WorkspaceBundle": { - "type": "structure", - "members": { - "BundleId": { - "target": "com.amazonaws.workspaces#BundleId", - "traits": { - "smithy.api#documentation": "

    The identifier of the bundle.

    " - } - }, - "Name": { - "target": "com.amazonaws.workspaces#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The name of the bundle.

    " - } - }, - "Owner": { - "target": "com.amazonaws.workspaces#BundleOwner", - "traits": { - "smithy.api#documentation": "

    The owner of the bundle. This is the account identifier of the owner, or\n AMAZON if the bundle is provided by Amazon Web Services.

    " - } - }, - "Description": { - "target": "com.amazonaws.workspaces#Description", - "traits": { - "smithy.api#documentation": "

    The description of the bundle.

    " - } - }, - "ImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", - "traits": { - "smithy.api#documentation": "

    The identifier of the image that was used to create the bundle.

    " - } - }, - "RootStorage": { - "target": "com.amazonaws.workspaces#RootStorage", - "traits": { - "smithy.api#documentation": "

    The size of the root volume.

    " - } - }, - "UserStorage": { - "target": "com.amazonaws.workspaces#UserStorage", - "traits": { - "smithy.api#documentation": "

    The size of the user volume.

    " - } - }, - "ComputeType": { - "target": "com.amazonaws.workspaces#ComputeType", - "traits": { - "smithy.api#documentation": "

    The compute type of the bundle. For more information, see \n Amazon WorkSpaces Bundles.

    " - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.workspaces#Timestamp", - "traits": { - "smithy.api#documentation": "

    The last time that the bundle was updated.

    " - } - }, - "CreationTime": { - "target": "com.amazonaws.workspaces#Timestamp", - "traits": { - "smithy.api#documentation": "

    The time when the bundle was created.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes a WorkSpace bundle.

    " - } - }, - "com.amazonaws.workspaces#WorkspaceBundleDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_./() -]+$" - } - }, - "com.amazonaws.workspaces#WorkspaceBundleName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_./()\\\\-]+$" - } - }, - "com.amazonaws.workspaces#WorkspaceConnectionStatus": { - "type": "structure", - "members": { - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " - } - }, - "ConnectionState": { - "target": "com.amazonaws.workspaces#ConnectionState", - "traits": { - "smithy.api#documentation": "

    The connection state of the WorkSpace. The connection state is unknown if the WorkSpace\n is stopped.

    " - } - }, - "ConnectionStateCheckTimestamp": { - "target": "com.amazonaws.workspaces#Timestamp", - "traits": { - "smithy.api#documentation": "

    The timestamp of the connection status check.

    " - } - }, - "LastKnownUserConnectionTimestamp": { - "target": "com.amazonaws.workspaces#Timestamp", - "traits": { - "smithy.api#documentation": "

    The timestamp of the last known user connection.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes the connection status of a WorkSpace.

    " - } - }, - "com.amazonaws.workspaces#WorkspaceConnectionStatusList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#WorkspaceConnectionStatus" - } - }, - "com.amazonaws.workspaces#WorkspaceCreationProperties": { - "type": "structure", - "members": { - "EnableWorkDocs": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

    \n \n \n

    If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the \n directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless \n you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, \n see Disabling Users in the \n Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see \n Deleting a Site in the \n Amazon WorkDocs Administration Guide.

    \n \n

    If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any \n new WorkSpaces that are launched in the directory will have WorkDocs enabled.

    \n     " - } - }, - "EnableInternetAccess": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Indicates whether internet access is enabled for your WorkSpaces.

    " - } - }, - "DefaultOu": { - "target": "com.amazonaws.workspaces#DefaultOu", - "traits": { - "smithy.api#documentation": "

    The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight \n Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form \n \"OU=value,DC=value,DC=value\", \n where value is any string of characters, and the number of domain components (DCs) is \n two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

    \n \n \n
      \n
    • \n

      To avoid errors, certain characters in the distinguished name must be escaped. For more information, \n see \n Distinguished Names in the Microsoft documentation.

      \n
      • \n
    • \n

      The API doesn't validate whether the OU exists.

      \n
      • \n
    \n     " - } - }, - "CustomSecurityGroupId": { - "target": "com.amazonaws.workspaces#SecurityGroupId", - "traits": { - "smithy.api#documentation": "

    The identifier of your custom security group.

    " - } - }, - "UserEnabledAsLocalAdministrator": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Indicates whether users are local administrators of their WorkSpaces.

    " - } - }, - "EnableMaintenanceMode": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Indicates whether maintenance mode is enabled for your WorkSpaces. For more information,\n see WorkSpace\n Maintenance.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes the default properties that are used for creating WorkSpaces. For more\n information, see Update Directory\n Details for Your WorkSpaces.

    " - } - }, - "com.amazonaws.workspaces#WorkspaceDirectory": { - "type": "structure", - "members": { - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The directory identifier.

    " - } - }, - "Alias": { - "target": "com.amazonaws.workspaces#Alias", - "traits": { - "smithy.api#documentation": "

    The directory alias.

    " - } - }, - "DirectoryName": { - "target": "com.amazonaws.workspaces#DirectoryName", - "traits": { - "smithy.api#documentation": "

    The name of the directory.

    " - } - }, - "RegistrationCode": { - "target": "com.amazonaws.workspaces#RegistrationCode", - "traits": { - "smithy.api#documentation": "

    The registration code for the directory. This is the code that users enter in their\n Amazon WorkSpaces client application to connect to the directory.

    " - } - }, - "SubnetIds": { - "target": "com.amazonaws.workspaces#SubnetIds", - "traits": { - "smithy.api#documentation": "

    The identifiers of the subnets used with the directory.

    " - } - }, - "DnsIpAddresses": { - "target": "com.amazonaws.workspaces#DnsIpAddresses", - "traits": { - "smithy.api#documentation": "

    The IP addresses of the DNS servers for the directory.

    " - } - }, - "CustomerUserName": { - "target": "com.amazonaws.workspaces#UserName", - "traits": { - "smithy.api#documentation": "

    The user name for the service account.

    " - } - }, - "IamRoleId": { - "target": "com.amazonaws.workspaces#ARN", - "traits": { - "smithy.api#documentation": "

    The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make\n calls to other services, such as Amazon EC2, on your behalf.

    " - } - }, - "DirectoryType": { - "target": "com.amazonaws.workspaces#WorkspaceDirectoryType", - "traits": { - "smithy.api#documentation": "

    The directory type.

    " - } - }, - "WorkspaceSecurityGroupId": { - "target": "com.amazonaws.workspaces#SecurityGroupId", - "traits": { - "smithy.api#documentation": "

    The identifier of the security group that is assigned to new WorkSpaces.

    " - } - }, - "State": { - "target": "com.amazonaws.workspaces#WorkspaceDirectoryState", - "traits": { - "smithy.api#documentation": "

    The state of the directory's registration with Amazon WorkSpaces. After a directory is \n deregistered, the DEREGISTERED state is returned very briefly before the directory \n metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, \n check for the directory ID by using \n \n DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been \n successfully deregistered.

    " - } - }, - "WorkspaceCreationProperties": { - "target": "com.amazonaws.workspaces#DefaultWorkspaceCreationProperties", - "traits": { - "smithy.api#documentation": "

    The default creation properties for all WorkSpaces in the directory.

    " - } - }, - "ipGroupIds": { - "target": "com.amazonaws.workspaces#IpGroupIdList", - "traits": { - "smithy.api#documentation": "

    The identifiers of the IP access control groups associated with the directory.

    " - } - }, - "WorkspaceAccessProperties": { - "target": "com.amazonaws.workspaces#WorkspaceAccessProperties", - "traits": { - "smithy.api#documentation": "

    The devices and operating systems that users can use to access WorkSpaces.

    " - } - }, - "Tenancy": { - "target": "com.amazonaws.workspaces#Tenancy", - "traits": { - "smithy.api#documentation": "

    Specifies whether the directory is dedicated or shared. To use Bring Your Own License\n (BYOL), this value must be set to DEDICATED. For more information, see Bring\n Your Own Windows Desktop Images.

    " - } - }, - "SelfservicePermissions": { - "target": "com.amazonaws.workspaces#SelfservicePermissions", - "traits": { - "smithy.api#documentation": "

    The default self-service permissions for WorkSpaces in the directory.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes a directory that is used with Amazon WorkSpaces.

    " - } - }, - "com.amazonaws.workspaces#WorkspaceDirectoryState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "REGISTERING", - "name": "REGISTERING" - }, - { - "value": "REGISTERED", - "name": "REGISTERED" - }, - { - "value": "DEREGISTERING", - "name": "DEREGISTERING" - }, - { - "value": "DEREGISTERED", - "name": "DEREGISTERED" - }, - { - "value": "ERROR", - "name": "ERROR" - } - ] - } - }, - "com.amazonaws.workspaces#WorkspaceDirectoryType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SIMPLE_AD", - "name": "SIMPLE_AD" - }, - { - "value": "AD_CONNECTOR", - "name": "AD_CONNECTOR" - } - ] - } - }, - "com.amazonaws.workspaces#WorkspaceErrorCode": { - "type": "string" - }, - "com.amazonaws.workspaces#WorkspaceId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^ws-[0-9a-z]{8,63}$" - } - }, - "com.amazonaws.workspaces#WorkspaceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#WorkspaceId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#WorkspaceImage": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", - "traits": { - "smithy.api#documentation": "

    The identifier of the image.

    " - } - }, - "Name": { - "target": "com.amazonaws.workspaces#WorkspaceImageName", - "traits": { - "smithy.api#documentation": "

    The name of the image.

    " - } - }, - "Description": { - "target": "com.amazonaws.workspaces#WorkspaceImageDescription", - "traits": { - "smithy.api#documentation": "

    The description of the image.

    " - } - }, - "OperatingSystem": { - "target": "com.amazonaws.workspaces#OperatingSystem", - "traits": { - "smithy.api#documentation": "

    The operating system that the image is running.

    " - } - }, - "State": { - "target": "com.amazonaws.workspaces#WorkspaceImageState", - "traits": { - "smithy.api#documentation": "

    The status of the image.

    " - } - }, - "RequiredTenancy": { - "target": "com.amazonaws.workspaces#WorkspaceImageRequiredTenancy", - "traits": { - "smithy.api#documentation": "

    Specifies whether the image is running on dedicated hardware. When Bring Your Own\n License (BYOL) is enabled, this value is set to DEDICATED. For more\n information, see Bring Your Own Windows\n Desktop Images.

    " - } - }, - "ErrorCode": { - "target": "com.amazonaws.workspaces#WorkspaceImageErrorCode", - "traits": { - "smithy.api#documentation": "

    The error code that is returned for the image.

    " - } - }, - "ErrorMessage": { - "target": "com.amazonaws.workspaces#Description", - "traits": { - "smithy.api#documentation": "

    The text of the error message that is returned for the image.

    " - } - }, - "Created": { - "target": "com.amazonaws.workspaces#Timestamp", - "traits": { - "smithy.api#documentation": "

    The date when the image was created. If the image has been shared, the Amazon Web Services account \n that the image has been shared with sees the original creation date of the image.

    " - } - }, - "OwnerAccountId": { - "target": "com.amazonaws.workspaces#AwsAccount", - "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Web Services account that owns the image.

    " - } - }, - "Updates": { - "target": "com.amazonaws.workspaces#UpdateResult", - "traits": { - "smithy.api#documentation": "

    The updates (if any) that are available for the specified image.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes a WorkSpace image.

    " - } - }, - "com.amazonaws.workspaces#WorkspaceImageDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_./() -]+$" - } - }, - "com.amazonaws.workspaces#WorkspaceImageErrorCode": { - "type": "string" - }, - "com.amazonaws.workspaces#WorkspaceImageId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^wsi-[0-9a-z]{9,63}$" - } - }, - "com.amazonaws.workspaces#WorkspaceImageIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#WorkspaceImageId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#WorkspaceImageIngestionProcess": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BYOL_REGULAR", - "name": "BYOL_REGULAR" - }, - { - "value": "BYOL_GRAPHICS", - "name": "BYOL_GRAPHICS" - }, - { - "value": "BYOL_GRAPHICSPRO", - "name": "BYOL_GRAPHICSPRO" - }, - { - "value": "BYOL_REGULAR_WSP", - "name": "BYOL_REGULAR_WSP" - } - ] - } - }, - "com.amazonaws.workspaces#WorkspaceImageList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#WorkspaceImage" - } - }, - "com.amazonaws.workspaces#WorkspaceImageName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_./()\\\\-]+$" - } - }, - "com.amazonaws.workspaces#WorkspaceImageRequiredTenancy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DEFAULT", - "name": "DEFAULT" - }, - { - "value": "DEDICATED", - "name": "DEDICATED" - } - ] - } - }, - "com.amazonaws.workspaces#WorkspaceImageState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "ERROR", - "name": "ERROR" - } - ] - } - }, - "com.amazonaws.workspaces#WorkspaceList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#Workspace" - } - }, - "com.amazonaws.workspaces#WorkspaceProperties": { - "type": "structure", - "members": { - "RunningMode": { - "target": "com.amazonaws.workspaces#RunningMode", - "traits": { - "smithy.api#documentation": "

    The running mode. For more information, see Manage the WorkSpace Running\n Mode.

    " - } - }, - "RunningModeAutoStopTimeoutInMinutes": { - "target": "com.amazonaws.workspaces#RunningModeAutoStopTimeoutInMinutes", - "traits": { - "smithy.api#documentation": "

    The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

    " - } - }, - "RootVolumeSizeGib": { - "target": "com.amazonaws.workspaces#RootVolumeSizeGib", - "traits": { - "smithy.api#documentation": "

    The size of the root volume. For important information about how to modify the size of the root and user volumes, see \n Modify a WorkSpace.

    " - } - }, - "UserVolumeSizeGib": { - "target": "com.amazonaws.workspaces#UserVolumeSizeGib", - "traits": { - "smithy.api#documentation": "

    The size of the user storage. For important information about how to modify the size of the root and user volumes, see \n Modify a WorkSpace.

    " - } - }, - "ComputeTypeName": { - "target": "com.amazonaws.workspaces#Compute", - "traits": { - "smithy.api#documentation": "

    The compute type. For more information, see Amazon WorkSpaces\n Bundles.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes a WorkSpace.

    " - } - }, - "com.amazonaws.workspaces#WorkspaceRequest": { - "type": "structure", - "members": { - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "

    The identifier of the Directory Service directory for the WorkSpace. You can use\n DescribeWorkspaceDirectories to list the available directories.

    ", - "smithy.api#required": {} - } - }, - "UserName": { - "target": "com.amazonaws.workspaces#UserName", - "traits": { - "smithy.api#documentation": "

    The user name of the user for the WorkSpace. This user name must exist in the Directory Service\n directory for the WorkSpace.

    ", - "smithy.api#required": {} - } - }, - "BundleId": { - "target": "com.amazonaws.workspaces#BundleId", - "traits": { - "smithy.api#documentation": "

    The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

    ", - "smithy.api#required": {} - } - }, - "VolumeEncryptionKey": { - "target": "com.amazonaws.workspaces#VolumeEncryptionKey", - "traits": { - "smithy.api#documentation": "

    The symmetric KMS key used to encrypt data stored on your WorkSpace. \n Amazon WorkSpaces does not support asymmetric KMS keys.

    " - } - }, - "UserVolumeEncryptionEnabled": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Indicates whether the data stored on the user volume is encrypted.

    " - } - }, - "RootVolumeEncryptionEnabled": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Indicates whether the data stored on the root volume is encrypted.

    " - } - }, - "WorkspaceProperties": { - "target": "com.amazonaws.workspaces#WorkspaceProperties", - "traits": { - "smithy.api#documentation": "

    The WorkSpace properties.

    " - } - }, - "Tags": { - "target": "com.amazonaws.workspaces#TagList", - "traits": { - "smithy.api#documentation": "

    The tags for the WorkSpace.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes the information used to create a WorkSpace.

    " - } - }, - "com.amazonaws.workspaces#WorkspaceRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#WorkspaceRequest" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.workspaces#WorkspaceState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "IMPAIRED", - "name": "IMPAIRED" - }, - { - "value": "UNHEALTHY", - "name": "UNHEALTHY" - }, - { - "value": "REBOOTING", - "name": "REBOOTING" - }, - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "REBUILDING", - "name": "REBUILDING" - }, - { - "value": "RESTORING", - "name": "RESTORING" - }, - { - "value": "MAINTENANCE", - "name": "MAINTENANCE" - }, - { - "value": "ADMIN_MAINTENANCE", - "name": "ADMIN_MAINTENANCE" - }, - { - "value": "TERMINATING", - "name": "TERMINATING" - }, - { - "value": "TERMINATED", - "name": "TERMINATED" - }, - { - "value": "SUSPENDED", - "name": "SUSPENDED" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "ERROR", - "name": "ERROR" - } + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } ] - } - }, - "com.amazonaws.workspaces#WorkspacesDefaultRoleNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

    The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you\n will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.

    ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.workspaces#WorkspacesIpGroup": { - "type": "structure", - "members": { - "groupId": { - "target": "com.amazonaws.workspaces#IpGroupId", - "traits": { - "smithy.api#documentation": "

    The identifier of the group.

    " - } - }, - "groupName": { - "target": "com.amazonaws.workspaces#IpGroupName", - "traits": { - "smithy.api#documentation": "

    The name of the group.

    " - } - }, - "groupDesc": { - "target": "com.amazonaws.workspaces#IpGroupDesc", - "traits": { - "smithy.api#documentation": "

    The description of the group.

    " - } - }, - "userRules": { - "target": "com.amazonaws.workspaces#IpRuleList", - "traits": { - "smithy.api#documentation": "

    The rules.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    Describes an IP access control group.

    " - } - }, - "com.amazonaws.workspaces#WorkspacesIpGroupsList": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#WorkspacesIpGroup" - } }, - "com.amazonaws.workspaces#WorkspacesService": { - "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "WorkSpaces", - "arnNamespace": "workspaces", - "cloudFormationName": "WorkSpaces", - "cloudTrailEventSource": "workspaces.amazonaws.com", - "endpointPrefix": "workspaces" - }, - "aws.auth#sigv4": { - "name": "workspaces" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon WorkSpaces Service\n

    Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and\n Amazon Linux desktops for your users.

    ", - "smithy.api#title": "Amazon WorkSpaces", - "smithy.api#xmlNamespace": { - "uri": "http://workspaces.amazonaws.com/api/v1" - } - }, - "version": "2015-04-08", - "operations": [ - { - "target": "com.amazonaws.workspaces#AssociateConnectionAlias" - }, - { - "target": "com.amazonaws.workspaces#AssociateIpGroups" - }, - { - "target": "com.amazonaws.workspaces#AuthorizeIpRules" - }, - { - "target": "com.amazonaws.workspaces#CopyWorkspaceImage" - }, - { - "target": "com.amazonaws.workspaces#CreateConnectClientAddIn" - }, - { - "target": "com.amazonaws.workspaces#CreateConnectionAlias" - }, - { - "target": "com.amazonaws.workspaces#CreateIpGroup" - }, - { - "target": "com.amazonaws.workspaces#CreateTags" - }, - { - "target": "com.amazonaws.workspaces#CreateUpdatedWorkspaceImage" - }, - { - "target": "com.amazonaws.workspaces#CreateWorkspaceBundle" - }, - { - "target": "com.amazonaws.workspaces#CreateWorkspaces" - }, - { - "target": "com.amazonaws.workspaces#DeleteConnectClientAddIn" - }, - { - "target": "com.amazonaws.workspaces#DeleteConnectionAlias" - }, - { - "target": "com.amazonaws.workspaces#DeleteIpGroup" - }, - { - "target": "com.amazonaws.workspaces#DeleteTags" - }, - { - "target": "com.amazonaws.workspaces#DeleteWorkspaceBundle" - }, - { - "target": "com.amazonaws.workspaces#DeleteWorkspaceImage" - }, - { - "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectory" - }, - { - "target": "com.amazonaws.workspaces#DescribeAccount" - }, - { - "target": "com.amazonaws.workspaces#DescribeAccountModifications" - }, - { - "target": "com.amazonaws.workspaces#DescribeClientProperties" - }, - { - "target": "com.amazonaws.workspaces#DescribeConnectClientAddIns" - }, - { - "target": "com.amazonaws.workspaces#DescribeConnectionAliases" - }, - { - "target": "com.amazonaws.workspaces#DescribeConnectionAliasPermissions" - }, - { - "target": "com.amazonaws.workspaces#DescribeIpGroups" - }, - { - "target": "com.amazonaws.workspaces#DescribeTags" - }, - { - "target": "com.amazonaws.workspaces#DescribeWorkspaceBundles" - }, - { - "target": "com.amazonaws.workspaces#DescribeWorkspaceDirectories" - }, - { - "target": "com.amazonaws.workspaces#DescribeWorkspaceImagePermissions" - }, - { - "target": "com.amazonaws.workspaces#DescribeWorkspaceImages" - }, - { - "target": "com.amazonaws.workspaces#DescribeWorkspaces" - }, - { - "target": "com.amazonaws.workspaces#DescribeWorkspacesConnectionStatus" - }, - { - "target": "com.amazonaws.workspaces#DescribeWorkspaceSnapshots" - }, - { - "target": "com.amazonaws.workspaces#DisassociateConnectionAlias" - }, - { - "target": "com.amazonaws.workspaces#DisassociateIpGroups" - }, - { - "target": "com.amazonaws.workspaces#ImportWorkspaceImage" - }, - { - "target": "com.amazonaws.workspaces#ListAvailableManagementCidrRanges" - }, - { - "target": "com.amazonaws.workspaces#MigrateWorkspace" - }, - { - "target": "com.amazonaws.workspaces#ModifyAccount" - }, - { - "target": "com.amazonaws.workspaces#ModifyClientProperties" - }, - { - "target": "com.amazonaws.workspaces#ModifySelfservicePermissions" - }, - { - "target": "com.amazonaws.workspaces#ModifyWorkspaceAccessProperties" - }, - { - "target": "com.amazonaws.workspaces#ModifyWorkspaceCreationProperties" - }, - { - "target": "com.amazonaws.workspaces#ModifyWorkspaceProperties" - }, - { - "target": "com.amazonaws.workspaces#ModifyWorkspaceState" - }, - { - "target": "com.amazonaws.workspaces#RebootWorkspaces" - }, - { - "target": "com.amazonaws.workspaces#RebuildWorkspaces" - }, - { - "target": "com.amazonaws.workspaces#RegisterWorkspaceDirectory" - }, - { - "target": "com.amazonaws.workspaces#RestoreWorkspace" - }, - { - "target": "com.amazonaws.workspaces#RevokeIpRules" - }, - { - "target": "com.amazonaws.workspaces#StartWorkspaces" - }, - { - "target": "com.amazonaws.workspaces#StopWorkspaces" - }, - { - "target": "com.amazonaws.workspaces#TerminateWorkspaces" - }, - { - "target": "com.amazonaws.workspaces#UpdateConnectClientAddIn" - }, - { - "target": "com.amazonaws.workspaces#UpdateConnectionAliasPermission" - }, - { - "target": "com.amazonaws.workspaces#UpdateRulesOfIpGroup" - }, - { - "target": "com.amazonaws.workspaces#UpdateWorkspaceBundle" - }, - { - "target": "com.amazonaws.workspaces#UpdateWorkspaceImagePermission" + "shapes": { + "com.amazonaws.workspaces#ARN": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:[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,127}$" + } + }, + "com.amazonaws.workspaces#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The user is not authorized to access a resource.

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#AccessPropertyValue": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALLOW", + "name": "ALLOW" + }, + { + "value": "DENY", + "name": "DENY" + } + ] + } + }, + "com.amazonaws.workspaces#AccountModification": { + "type": "structure", + "members": { + "ModificationState": { + "target": "com.amazonaws.workspaces#DedicatedTenancyModificationStateEnum", + "traits": { + "smithy.api#documentation": "

    The state of the modification to the configuration of BYOL.

    " + } + }, + "DedicatedTenancySupport": { + "target": "com.amazonaws.workspaces#DedicatedTenancySupportResultEnum", + "traits": { + "smithy.api#documentation": "

    The status of BYOL (whether BYOL is being enabled or disabled).

    " + } + }, + "DedicatedTenancyManagementCidrRange": { + "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange", + "traits": { + "smithy.api#documentation": "

    The IP address range, specified as an IPv4 CIDR block, for the management network\n interface used for the account.

    " + } + }, + "StartTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

    The timestamp when the modification of the BYOL configuration was started.

    " + } + }, + "ErrorCode": { + "target": "com.amazonaws.workspaces#WorkspaceErrorCode", + "traits": { + "smithy.api#documentation": "

    The error code that is returned if the configuration of BYOL cannot be modified.

    " + } + }, + "ErrorMessage": { + "target": "com.amazonaws.workspaces#Description", + "traits": { + "smithy.api#documentation": "

    The text of the error message that is returned if the configuration of BYOL cannot be\n modified.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a modification to the configuration of Bring Your Own License (BYOL) for the\n specified account.

    " + } + }, + "com.amazonaws.workspaces#AccountModificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#AccountModification" + } + }, + "com.amazonaws.workspaces#AddInName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.workspaces#AddInUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^(http|https)\\://\\S+$" + } + }, + "com.amazonaws.workspaces#Alias": { + "type": "string" + }, + "com.amazonaws.workspaces#AmazonUuid": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.workspaces#Application": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Microsoft_Office_2016", + "name": "Microsoft_Office_2016" + }, + { + "value": "Microsoft_Office_2019", + "name": "Microsoft_Office_2019" + } + ] + } + }, + "com.amazonaws.workspaces#ApplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#Application" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.workspaces#AssociateConnectionAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#AssociateConnectionAliasRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#AssociateConnectionAliasResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAssociatedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Associates the specified connection alias with the specified directory to enable\n cross-Region redirection. For more information, see Cross-Region\n Redirection for Amazon WorkSpaces.

    \n \n

    Before performing this operation, call \n DescribeConnectionAliases to make sure that the current state of the\n connection alias is CREATED.

    \n     " + } + }, + "com.amazonaws.workspaces#AssociateConnectionAliasRequest": { + "type": "structure", + "members": { + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias.

    ", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the directory to associate the connection alias with.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#AssociateConnectionAliasResult": { + "type": "structure", + "members": { + "ConnectionIdentifier": { + "target": "com.amazonaws.workspaces#ConnectionIdentifier", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias association. You use the connection identifier in\n the DNS TXT record when you're configuring your DNS routing policies.

    " + } + } + } + }, + "com.amazonaws.workspaces#AssociateIpGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#AssociateIpGroupsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#AssociateIpGroupsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Associates the specified IP access control group with the specified directory.

    " + } + }, + "com.amazonaws.workspaces#AssociateIpGroupsRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The identifier of the directory.

    ", + "smithy.api#required": {} + } + }, + "GroupIds": { + "target": "com.amazonaws.workspaces#IpGroupIdList", + "traits": { + "smithy.api#documentation": "

    The identifiers of one or more IP access control groups.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#AssociateIpGroupsResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#AssociationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NOT_ASSOCIATED", + "name": "NOT_ASSOCIATED" + }, + { + "value": "ASSOCIATED_WITH_OWNER_ACCOUNT", + "name": "ASSOCIATED_WITH_OWNER_ACCOUNT" + }, + { + "value": "ASSOCIATED_WITH_SHARED_ACCOUNT", + "name": "ASSOCIATED_WITH_SHARED_ACCOUNT" + }, + { + "value": "PENDING_ASSOCIATION", + "name": "PENDING_ASSOCIATION" + }, + { + "value": "PENDING_DISASSOCIATION", + "name": "PENDING_DISASSOCIATION" + } + ] + } + }, + "com.amazonaws.workspaces#AuthorizeIpRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#AuthorizeIpRulesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#AuthorizeIpRulesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Adds one or more rules to the specified IP access control group.

    \n

    This action gives users permission to access their WorkSpaces from the CIDR address\n ranges specified in the rules.

    " + } + }, + "com.amazonaws.workspaces#AuthorizeIpRulesRequest": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.workspaces#IpGroupId", + "traits": { + "smithy.api#documentation": "

    The identifier of the group.

    ", + "smithy.api#required": {} + } + }, + "UserRules": { + "target": "com.amazonaws.workspaces#IpRuleList", + "traits": { + "smithy.api#documentation": "

    The rules to add to the group.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#AuthorizeIpRulesResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#AwsAccount": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.workspaces#BooleanObject": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.workspaces#BundleId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^wsb-[0-9a-z]{8,63}$" + } + }, + "com.amazonaws.workspaces#BundleIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#BundleId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#BundleList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspaceBundle" + } + }, + "com.amazonaws.workspaces#BundleOwner": { + "type": "string" + }, + "com.amazonaws.workspaces#ClientDeviceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DeviceTypeWindows", + "name": "DEVICE_TYPE_WINDOWS" + }, + { + "value": "DeviceTypeOsx", + "name": "DEVICE_TYPE_OSX" + }, + { + "value": "DeviceTypeAndroid", + "name": "DEVICE_TYPE_ANDROID" + }, + { + "value": "DeviceTypeIos", + "name": "DEVICE_TYPE_IOS" + }, + { + "value": "DeviceTypeLinux", + "name": "DEVICE_TYPE_LINUX" + }, + { + "value": "DeviceTypeWeb", + "name": "DEVICE_TYPE_WEB" + } + ] + } + }, + "com.amazonaws.workspaces#ClientDeviceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ClientDeviceType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, + "com.amazonaws.workspaces#ClientEmail": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 6, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,4}$" + } + }, + "com.amazonaws.workspaces#ClientLocale": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 5 + }, + "smithy.api#pattern": "^[a-z]{2}_[A-Z]{2}$" + } + }, + "com.amazonaws.workspaces#ClientLoginMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 600 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.workspaces#ClientProperties": { + "type": "structure", + "members": { + "ReconnectEnabled": { + "target": "com.amazonaws.workspaces#ReconnectEnum", + "traits": { + "smithy.api#documentation": "

    Specifies whether users can cache their credentials on the Amazon WorkSpaces client.\n When enabled, users can choose to reconnect to their WorkSpaces without re-entering their\n credentials.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes an Amazon WorkSpaces client.

    " + } + }, + "com.amazonaws.workspaces#ClientPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ClientPropertiesResult" + } + }, + "com.amazonaws.workspaces#ClientPropertiesResult": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The resource identifier, in the form of a directory ID.

    " + } + }, + "ClientProperties": { + "target": "com.amazonaws.workspaces#ClientProperties", + "traits": { + "smithy.api#documentation": "

    Information about the Amazon WorkSpaces client.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about the Amazon WorkSpaces client.

    " + } + }, + "com.amazonaws.workspaces#ClientUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^(http|https)\\://\\S+$" + } + }, + "com.amazonaws.workspaces#Compute": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VALUE", + "name": "VALUE" + }, + { + "value": "STANDARD", + "name": "STANDARD" + }, + { + "value": "PERFORMANCE", + "name": "PERFORMANCE" + }, + { + "value": "POWER", + "name": "POWER" + }, + { + "value": "GRAPHICS", + "name": "GRAPHICS" + }, + { + "value": "POWERPRO", + "name": "POWERPRO" + }, + { + "value": "GRAPHICSPRO", + "name": "GRAPHICSPRO" + } + ] + } + }, + "com.amazonaws.workspaces#ComputeType": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.workspaces#Compute", + "traits": { + "smithy.api#documentation": "

    The compute type.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the compute type of the bundle.

    " + } + }, + "com.amazonaws.workspaces#ComputerName": { + "type": "string" + }, + "com.amazonaws.workspaces#ConnectClientAddIn": { + "type": "structure", + "members": { + "AddInId": { + "target": "com.amazonaws.workspaces#AmazonUuid", + "traits": { + "smithy.api#documentation": "

    The client add-in identifier.

    " + } + }, + "ResourceId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The directory identifier for which the client add-in is configured.

    " + } + }, + "Name": { + "target": "com.amazonaws.workspaces#AddInName", + "traits": { + "smithy.api#documentation": "

    The name of the client add in.

    " + } + }, + "URL": { + "target": "com.amazonaws.workspaces#AddInUrl", + "traits": { + "smithy.api#documentation": "

    The endpoint URL of the client add-in.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes an Amazon Connect client add-in.

    " + } + }, + "com.amazonaws.workspaces#ConnectClientAddInList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ConnectClientAddIn" + } + }, + "com.amazonaws.workspaces#ConnectionAlias": { + "type": "structure", + "members": { + "ConnectionString": { + "target": "com.amazonaws.workspaces#ConnectionString", + "traits": { + "smithy.api#documentation": "

    The connection string specified for the connection alias. The connection string must be\n in the form of a fully qualified domain name (FQDN), such as\n www.example.com.

    " + } + }, + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias.

    " + } + }, + "State": { + "target": "com.amazonaws.workspaces#ConnectionAliasState", + "traits": { + "smithy.api#documentation": "

    The current state of the connection alias.

    " + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", + "traits": { + "smithy.api#documentation": "

    The identifier of the Amazon Web Services account that owns the connection alias.

    " + } + }, + "Associations": { + "target": "com.amazonaws.workspaces#ConnectionAliasAssociationList", + "traits": { + "smithy.api#documentation": "

    The association status of the connection alias.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a connection alias. Connection aliases are used for cross-Region redirection.\n For more information, see Cross-Region\n Redirection for Amazon WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#ConnectionAliasAssociation": { + "type": "structure", + "members": { + "AssociationStatus": { + "target": "com.amazonaws.workspaces#AssociationStatus", + "traits": { + "smithy.api#documentation": "

    The association status of the connection alias.

    " + } + }, + "AssociatedAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", + "traits": { + "smithy.api#documentation": "

    The identifier of the Amazon Web Services account that associated the connection alias\n with a directory.

    " + } + }, + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the directory associated with a connection alias.

    " + } + }, + "ConnectionIdentifier": { + "target": "com.amazonaws.workspaces#ConnectionIdentifier", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias association. You use the connection identifier in\n the DNS TXT record when you're configuring your DNS routing policies.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a connection alias association that is used for cross-Region redirection. For\n more information, see Cross-Region\n Redirection for Amazon WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#ConnectionAliasAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ConnectionAliasAssociation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#ConnectionAliasId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 13, + "max": 68 + }, + "smithy.api#pattern": "^wsca-[0-9a-z]{8,63}$" + } + }, + "com.amazonaws.workspaces#ConnectionAliasIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ConnectionAliasId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#ConnectionAliasList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ConnectionAlias" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#ConnectionAliasPermission": { + "type": "structure", + "members": { + "SharedAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", + "traits": { + "smithy.api#documentation": "

    The identifier of the Amazon Web Services account that the connection alias is shared\n with.

    ", + "smithy.api#required": {} + } + }, + "AllowAssociation": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether the specified Amazon Web Services account is allowed to associate the\n connection alias with a directory.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the permissions for a connection alias. Connection aliases are used for\n cross-Region redirection. For more information, see Cross-Region\n Redirection for Amazon WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#ConnectionAliasPermissions": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ConnectionAliasPermission" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#ConnectionAliasState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "DELETING", + "name": "DELETING" + } + ] + } + }, + "com.amazonaws.workspaces#ConnectionIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.workspaces#ConnectionState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CONNECTED", + "name": "CONNECTED" + }, + { + "value": "DISCONNECTED", + "name": "DISCONNECTED" + }, + { + "value": "UNKNOWN", + "name": "UNKNOWN" + } + ] + } + }, + "com.amazonaws.workspaces#ConnectionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[.0-9a-zA-Z\\-]{1,255}$" + } + }, + "com.amazonaws.workspaces#CopyWorkspaceImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#CopyWorkspaceImageRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#CopyWorkspaceImageResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspaces#ResourceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

    Copies the specified image from the specified Region to the current Region. For more\n information about copying images, see Copy a Custom WorkSpaces\n Image.

    \n

    In the China (Ningxia) Region, you can copy images only within the same Region.

    \n

    In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

    \n \n

    Before copying a shared image, be sure to verify that it has been shared from the\n correct Amazon Web Services account. To determine if an image has been shared and to see\n the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.

    \n     " + } + }, + "com.amazonaws.workspaces#CopyWorkspaceImageRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.workspaces#WorkspaceImageName", + "traits": { + "smithy.api#documentation": "

    The name of the image.

    ", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.workspaces#WorkspaceImageDescription", + "traits": { + "smithy.api#documentation": "

    A description of the image.

    " + } + }, + "SourceImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the source image.

    ", + "smithy.api#required": {} + } + }, + "SourceRegion": { + "target": "com.amazonaws.workspaces#Region", + "traits": { + "smithy.api#documentation": "

    The identifier of the source Region.

    ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

    The tags for the image.

    " + } + } + } + }, + "com.amazonaws.workspaces#CopyWorkspaceImageResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the image.

    " + } + } + } + }, + "com.amazonaws.workspaces#CreateConnectClientAddIn": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#CreateConnectClientAddInRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#CreateConnectClientAddInResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.workspaces#ResourceCreationFailedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates a client-add-in for Amazon Connect within a directory. You can create only\n one Amazon Connect client add-in within a directory.

    \n

    This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.

    " + } + }, + "com.amazonaws.workspaces#CreateConnectClientAddInRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The directory identifier for which to configure the client add-in.

    ", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.workspaces#AddInName", + "traits": { + "smithy.api#documentation": "

    The name of the client add-in.

    ", + "smithy.api#required": {} + } + }, + "URL": { + "target": "com.amazonaws.workspaces#AddInUrl", + "traits": { + "smithy.api#documentation": "

    The endpoint URL of the Amazon Connect client add-in.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#CreateConnectClientAddInResult": { + "type": "structure", + "members": { + "AddInId": { + "target": "com.amazonaws.workspaces#AmazonUuid", + "traits": { + "smithy.api#documentation": "

    The client add-in identifier.

    " + } + } + } + }, + "com.amazonaws.workspaces#CreateConnectionAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#CreateConnectionAliasRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#CreateConnectionAliasResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates the specified connection alias for use with cross-Region redirection. For more\n information, see Cross-Region\n Redirection for Amazon WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#CreateConnectionAliasRequest": { + "type": "structure", + "members": { + "ConnectionString": { + "target": "com.amazonaws.workspaces#ConnectionString", + "traits": { + "smithy.api#documentation": "

    A connection string in the form of a fully qualified domain name (FQDN), such as\n www.example.com.

    \n \n

    After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different\n account, even if you delete all instances of it from the original account. The\n connection string is globally reserved for your account.

    \n     ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

    The tags to associate with the connection alias.

    " + } + } + } + }, + "com.amazonaws.workspaces#CreateConnectionAliasResult": { + "type": "structure", + "members": { + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias.

    " + } + } + } + }, + "com.amazonaws.workspaces#CreateIpGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#CreateIpGroupRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#CreateIpGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.workspaces#ResourceCreationFailedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates an IP access control group.

    \n

    An IP access control group provides you with the ability to control the IP addresses\n from which users are allowed to access their WorkSpaces. To specify the CIDR address\n ranges, add rules to your IP access control group and then associate the group with your\n directory. You can add rules when you create the group or at any time using AuthorizeIpRules.

    \n

    There is a default IP access control group associated with your directory. If you don't\n associate an IP access control group with your directory, the default group is used. The\n default group includes a default rule that allows users to access their WorkSpaces from\n anywhere. You cannot modify the default IP access control group for your directory.

    " + } + }, + "com.amazonaws.workspaces#CreateIpGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.workspaces#IpGroupName", + "traits": { + "smithy.api#documentation": "

    The name of the group.

    ", + "smithy.api#required": {} + } + }, + "GroupDesc": { + "target": "com.amazonaws.workspaces#IpGroupDesc", + "traits": { + "smithy.api#documentation": "

    The description of the group.

    " + } + }, + "UserRules": { + "target": "com.amazonaws.workspaces#IpRuleList", + "traits": { + "smithy.api#documentation": "

    The rules to add to the group.

    " + } + }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    " + } + } + } + }, + "com.amazonaws.workspaces#CreateIpGroupResult": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.workspaces#IpGroupId", + "traits": { + "smithy.api#documentation": "

    The identifier of the group.

    " + } + } + } + }, + "com.amazonaws.workspaces#CreateTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#CreateTagsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#CreateTagsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates the specified tags for the specified WorkSpaces resource.

    " + } + }, + "com.amazonaws.workspaces#CreateTagsRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, IP access control groups, and connection\n aliases.

    ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#CreateTagsResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#CreateUpdatedWorkspaceImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#CreateUpdatedWorkspaceImageRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#CreateUpdatedWorkspaceImageResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates a new updated WorkSpace image based on the specified source image. The new\n updated WorkSpace image has the latest drivers and other updates required by the Amazon\n WorkSpaces components.

    \n

    To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces\n requirements, use \n DescribeWorkspaceImages.

    \n \n
      \n
    • \n

      Only Windows 10, Windows Sever 2016, and Windows Server 2019 WorkSpace images\n can be programmatically updated at this time.

      \n
      • \n
    • \n

      Microsoft Windows updates and other application updates are not included in the\n update process.

      \n
      • \n
    • \n

      The source WorkSpace image is not deleted. You can delete the source image\n after you've verified your new updated image and created a new bundle.

      \n
      • \n
    \n     " + } + }, + "com.amazonaws.workspaces#CreateUpdatedWorkspaceImageRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.workspaces#WorkspaceImageName", + "traits": { + "smithy.api#documentation": "

    The name of the new updated WorkSpace image.

    ", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.workspaces#WorkspaceImageDescription", + "traits": { + "smithy.api#documentation": "

    A description of whether updates for the WorkSpace image are available.

    ", + "smithy.api#required": {} + } + }, + "SourceImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the source WorkSpace image.

    ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

    The tags that you want to add to the new updated WorkSpace image.

    \n \n

    To add tags at the same time when you're creating the updated image, you must create\n an IAM policy that grants your IAM user permissions to use\n workspaces:CreateTags.

    \n     " + } + } + } + }, + "com.amazonaws.workspaces#CreateUpdatedWorkspaceImageResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the new updated WorkSpace image.

    " + } + } + } + }, + "com.amazonaws.workspaces#CreateWorkspaceBundle": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#CreateWorkspaceBundleRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#CreateWorkspaceBundleResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspaces#ResourceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see \n \n Create a Custom WorkSpaces Image and Bundle.

    " + } + }, + "com.amazonaws.workspaces#CreateWorkspaceBundleRequest": { + "type": "structure", + "members": { + "BundleName": { + "target": "com.amazonaws.workspaces#WorkspaceBundleName", + "traits": { + "smithy.api#documentation": "

    The name of the bundle.

    ", + "smithy.api#required": {} + } + }, + "BundleDescription": { + "target": "com.amazonaws.workspaces#WorkspaceBundleDescription", + "traits": { + "smithy.api#documentation": "

    The description of the bundle.

    ", + "smithy.api#required": {} + } + }, + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the image that is used to create the bundle.

    ", + "smithy.api#required": {} + } + }, + "ComputeType": { + "target": "com.amazonaws.workspaces#ComputeType", + "traits": { + "smithy.api#required": {} + } + }, + "UserStorage": { + "target": "com.amazonaws.workspaces#UserStorage", + "traits": { + "smithy.api#required": {} + } + }, + "RootStorage": { + "target": "com.amazonaws.workspaces#RootStorage" + }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

    The tags associated with the bundle.

    \n \n \n

    To add tags at the same time when you're creating the bundle, you must create an IAM policy that \n grants your IAM user permissions to use workspaces:CreateTags.

    \n     " + } + } + } + }, + "com.amazonaws.workspaces#CreateWorkspaceBundleResult": { + "type": "structure", + "members": { + "WorkspaceBundle": { + "target": "com.amazonaws.workspaces#WorkspaceBundle" + } + } + }, + "com.amazonaws.workspaces#CreateWorkspaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#CreateWorkspacesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#CreateWorkspacesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates one or more WorkSpaces.

    \n

    This operation is asynchronous and returns before the WorkSpaces are created.

    " + } + }, + "com.amazonaws.workspaces#CreateWorkspacesRequest": { + "type": "structure", + "members": { + "Workspaces": { + "target": "com.amazonaws.workspaces#WorkspaceRequestList", + "traits": { + "smithy.api#documentation": "

    The WorkSpaces to create. You can specify up to 25 WorkSpaces.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#CreateWorkspacesResult": { + "type": "structure", + "members": { + "FailedRequests": { + "target": "com.amazonaws.workspaces#FailedCreateWorkspaceRequests", + "traits": { + "smithy.api#documentation": "

    Information about the WorkSpaces that could not be created.

    " + } + }, + "PendingRequests": { + "target": "com.amazonaws.workspaces#WorkspaceList", + "traits": { + "smithy.api#documentation": "

    Information about the WorkSpaces that were created.

    \n

    Because this operation is asynchronous, the identifier returned is not immediately\n available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned\n can be incomplete.

    " + } + } + } + }, + "com.amazonaws.workspaces#DedicatedTenancyCidrRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange" + } + }, + "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange": { + "type": "string", + "traits": { + "smithy.api#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$))$" + } + }, + "com.amazonaws.workspaces#DedicatedTenancyModificationStateEnum": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.workspaces#DedicatedTenancySupportEnum": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + } + ] + } + }, + "com.amazonaws.workspaces#DedicatedTenancySupportResultEnum": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, + "com.amazonaws.workspaces#DefaultClientBrandingAttributes": { + "type": "structure", + "members": { + "LogoUrl": { + "target": "com.amazonaws.workspaces#ClientUrl", + "traits": { + "smithy.api#documentation": "

    The logo URL. This is the link where users can download the logo image. The only\n supported image format is .png.

    " + } + }, + "SupportEmail": { + "target": "com.amazonaws.workspaces#ClientEmail", + "traits": { + "smithy.api#documentation": "

    The support email. The company's customer support email address.

    \n \n
      \n
    • \n

      In each platform type, the SupportEmail and\n SupportLink parameters are mutually exclusive. You can specify one\n parameter for each platform type, but not both.

      \n
      • \n
    • \n

      The default email is workspaces-feedback@amazon.com.

      \n
      • \n
    \n     " + } + }, + "SupportLink": { + "target": "com.amazonaws.workspaces#ClientUrl", + "traits": { + "smithy.api#documentation": "

    The support link. The link for the company's customer support page for their\n WorkSpace.

    \n \n
      \n
    • \n

      In each platform type, the SupportEmail and\n SupportLink parameters are mutually exclusive.You can specify one\n parameter for each platform type, but not both.

      \n
      • \n
    • \n

      The default support link is workspaces-feedback@amazon.com.

      \n
      • \n
    \n     " + } + }, + "ForgotPasswordLink": { + "target": "com.amazonaws.workspaces#ClientUrl", + "traits": { + "smithy.api#documentation": "

    The forgotten password link. This is the web address that users can go to if they forget\n the password for their WorkSpace.

    " + } + }, + "LoginMessage": { + "target": "com.amazonaws.workspaces#LoginMessage", + "traits": { + "smithy.api#documentation": "

    The login message. Specified as a key value pair, in which the key is a locale and the\n value is the localized message for that locale. The only key supported is\n en_US.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Returns default client branding attributes that were imported. These attributes display\n on the client login screen.

    \n \n

    Client branding attributes are public facing. Ensure that you don't include sensitive\n information.

    \n     " + } + }, + "com.amazonaws.workspaces#DefaultImportClientBrandingAttributes": { + "type": "structure", + "members": { + "Logo": { + "target": "com.amazonaws.workspaces#DefaultLogo", + "traits": { + "smithy.api#documentation": "

    The logo. This is the link where users can download the logo image. The only image\n format accepted is .png.

    " + } + }, + "SupportEmail": { + "target": "com.amazonaws.workspaces#ClientEmail", + "traits": { + "smithy.api#documentation": "

    The support email. The company's customer support email address.

    \n \n
      \n
    • \n

      In each platform type, the SupportEmail and\n SupportLink parameters are mutually exclusive. You can specify one\n parameter for each platform type, but not both.

      \n
      • \n
    • \n

      The default email is workspaces-feedback@amazon.com.

      \n
      • \n
    \n     " + } + }, + "SupportLink": { + "target": "com.amazonaws.workspaces#ClientUrl", + "traits": { + "smithy.api#documentation": "

    The support link. The link for the company's customer support page for their\n WorkSpace.

    \n \n
      \n
    • \n

      In each platform type, the SupportEmail and\n SupportLink parameters are mutually exclusive. You can specify one\n parameter for each platform type, but not both.

      \n
      • \n
    • \n

      The default support link is workspaces-feedback@amazon.com.

      \n
      • \n
    \n     " + } + }, + "ForgotPasswordLink": { + "target": "com.amazonaws.workspaces#ClientUrl", + "traits": { + "smithy.api#documentation": "

    The forgotten password link. This is the web address that users can go to if they forget\n the password for their WorkSpace.

    " + } + }, + "LoginMessage": { + "target": "com.amazonaws.workspaces#LoginMessage", + "traits": { + "smithy.api#documentation": "

    The login message. Specified as a key value pair, in which the key is a locale and the\n value is the localized message for that locale. The only key supported is\n en_US.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The default client branding attributes to be imported. These attributes display on the\n client login screen.

    \n \n

    Client branding attributes are public facing. Ensure that you do not include\n sensitive information.

    \n     " + } + }, + "com.amazonaws.workspaces#DefaultLogo": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1500000 + } + } + }, + "com.amazonaws.workspaces#DefaultOu": { + "type": "string" + }, + "com.amazonaws.workspaces#DefaultWorkspaceCreationProperties": { + "type": "structure", + "members": { + "EnableWorkDocs": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Specifies whether the directory is enabled for Amazon WorkDocs.

    " + } + }, + "EnableInternetAccess": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in\n this directory by default. If enabled, the Elastic public IP address allows outbound\n internet access from your WorkSpaces when you’re using an internet gateway in the Amazon\n VPC in which your WorkSpaces are located. If you're using a Network Address Translation\n (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in\n public subnets and you manually assign them Elastic IP addresses, you should disable this\n setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces\n that you rebuild. For more information, see Configure a VPC for\n Amazon WorkSpaces.

    " + } + }, + "DefaultOu": { + "target": "com.amazonaws.workspaces#DefaultOu", + "traits": { + "smithy.api#documentation": "

    The organizational unit (OU) in the directory for the WorkSpace machine accounts.

    " + } + }, + "CustomSecurityGroupId": { + "target": "com.amazonaws.workspaces#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

    The identifier of the default security group to apply to WorkSpaces when they are\n created. For more information, see Security\n Groups for Your WorkSpaces.

    " + } + }, + "UserEnabledAsLocalAdministrator": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Specifies whether WorkSpace users are local administrators on their WorkSpaces.

    " + } + }, + "EnableMaintenanceMode": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see\n WorkSpace\n Maintenance.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the default values that are used to create WorkSpaces. For more information,\n see Update Directory\n Details for Your WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#DeleteClientBranding": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DeleteClientBrandingRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DeleteClientBrandingResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes customized client branding. Client branding allows you to customize your\n WorkSpace's client login portal. You can tailor your login portal company logo, the support\n email address, support link, link to reset password, and a custom message for users trying\n to sign in.

    \n

    After you delete your customized client branding, your login portal reverts to the\n default client branding.

    " + } + }, + "com.amazonaws.workspaces#DeleteClientBrandingRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The directory identifier of the WorkSpace for which you want to delete client\n branding.

    ", + "smithy.api#required": {} + } + }, + "Platforms": { + "target": "com.amazonaws.workspaces#ClientDeviceTypeList", + "traits": { + "smithy.api#documentation": "

    The device type for which you want to delete client branding.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DeleteClientBrandingResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#DeleteConnectClientAddIn": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DeleteConnectClientAddInRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DeleteConnectClientAddInResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes a client-add-in for Amazon Connect that is configured within a\n directory.

    " + } + }, + "com.amazonaws.workspaces#DeleteConnectClientAddInRequest": { + "type": "structure", + "members": { + "AddInId": { + "target": "com.amazonaws.workspaces#AmazonUuid", + "traits": { + "smithy.api#documentation": "

    The identifier of the client add-in to delete.

    ", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The directory identifier for which the client add-in is configured.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DeleteConnectClientAddInResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#DeleteConnectionAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DeleteConnectionAliasRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DeleteConnectionAliasResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAssociatedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes the specified connection alias. For more information, see \n Cross-Region Redirection for Amazon WorkSpaces.

    \n \n

    \n If you will no longer be using a fully qualified domain name\n (FQDN) as the registration code for your WorkSpaces users, you must take certain\n precautions to prevent potential security issues. For more information,\n see Security Considerations if You Stop Using Cross-Region Redirection.

    \n     \n \n

    To delete a connection alias that has been shared, the shared account must first\n disassociate the connection alias from any directories it has been associated with. Then\n you must unshare the connection alias from the account it has been shared with. You can\n delete a connection alias only after it is no longer shared with any accounts or\n associated with any directories.

    \n     " + } + }, + "com.amazonaws.workspaces#DeleteConnectionAliasRequest": { + "type": "structure", + "members": { + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias to delete.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DeleteConnectionAliasResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#DeleteIpGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DeleteIpGroupRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DeleteIpGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAssociatedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes the specified IP access control group.

    \n

    You cannot delete an IP access control group that is associated with a directory.

    " + } + }, + "com.amazonaws.workspaces#DeleteIpGroupRequest": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.workspaces#IpGroupId", + "traits": { + "smithy.api#documentation": "

    The identifier of the IP access control group.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DeleteIpGroupResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#DeleteTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DeleteTagsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DeleteTagsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes the specified tags from the specified WorkSpaces resource.

    " + } + }, + "com.amazonaws.workspaces#DeleteTagsRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, IP access control groups, and connection\n aliases.

    ", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.workspaces#TagKeyList", + "traits": { + "smithy.api#documentation": "

    The tag keys.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DeleteTagsResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#DeleteWorkspaceBundle": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DeleteWorkspaceBundleRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DeleteWorkspaceBundleResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAssociatedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see \n \n Delete a Custom WorkSpaces Bundle or Image.

    " + } + }, + "com.amazonaws.workspaces#DeleteWorkspaceBundleRequest": { + "type": "structure", + "members": { + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", + "traits": { + "smithy.api#documentation": "

    The identifier of the bundle.

    " + } + } + } + }, + "com.amazonaws.workspaces#DeleteWorkspaceBundleResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#DeleteWorkspaceImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DeleteWorkspaceImageRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DeleteWorkspaceImageResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAssociatedException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes the specified image from your account. To delete an image, you must first delete\n any bundles that are associated with the image and unshare the image if it is shared with\n other accounts.

    " + } + }, + "com.amazonaws.workspaces#DeleteWorkspaceImageRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the image.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DeleteWorkspaceImageResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#DeregisterWorkspaceDirectory": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deregisters the specified directory. This operation is asynchronous and returns before\n the WorkSpace directory is deregistered. If any WorkSpaces are registered to this\n directory, you must remove them before you can deregister the directory.

    \n \n

    Simple AD and AD Connector are made available to you free of charge to use with\n WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector\n directory for 30 consecutive days, this directory will be automatically deregistered for\n use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing\n terms.

    \n

    To delete empty directories, see Delete the\n Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector\n directory, you can always create a new one when you want to start using WorkSpaces\n again.

    \n     " + } + }, + "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The identifier of the directory. If any WorkSpaces are registered to this directory, you\n must remove them before you deregister the directory, or you will receive an\n OperationNotSupportedException error.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#DescribeAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeAccountRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeAccountResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for\n the specified account.

    " + } + }, + "com.amazonaws.workspaces#DescribeAccountModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeAccountModificationsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeAccountModificationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves a list that describes modifications to the configuration of Bring Your Own\n License (BYOL) for the specified account.

    " + } + }, + "com.amazonaws.workspaces#DescribeAccountModificationsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeAccountModificationsResult": { + "type": "structure", + "members": { + "AccountModifications": { + "target": "com.amazonaws.workspaces#AccountModificationList", + "traits": { + "smithy.api#documentation": "

    The list of modifications to the configuration of BYOL.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeAccountRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#DescribeAccountResult": { + "type": "structure", + "members": { + "DedicatedTenancySupport": { + "target": "com.amazonaws.workspaces#DedicatedTenancySupportResultEnum", + "traits": { + "smithy.api#documentation": "

    The status of BYOL (whether BYOL is enabled or disabled).

    " + } + }, + "DedicatedTenancyManagementCidrRange": { + "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange", + "traits": { + "smithy.api#documentation": "

    The IP address range, specified as an IPv4 CIDR block, used for the management network\n interface.

    \n

    The management network interface is connected to a secure Amazon WorkSpaces management\n network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces\n clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeClientBranding": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeClientBrandingRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeClientBrandingResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the specified client branding. Client branding allows you to customize the log\n in page of various device types for your users. You can add your company logo, the support\n email address, support link, link to reset password, and a custom message for users trying\n to sign in.

    \n \n

    Only device types that have branding information configured will be shown in the\n response.

    \n     " + } + }, + "com.amazonaws.workspaces#DescribeClientBrandingRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The directory identifier of the WorkSpace for which you want to view client branding\n information.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DescribeClientBrandingResult": { + "type": "structure", + "members": { + "DeviceTypeWindows": { + "target": "com.amazonaws.workspaces#DefaultClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information for Windows devices.

    " + } + }, + "DeviceTypeOsx": { + "target": "com.amazonaws.workspaces#DefaultClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information for macOS devices.

    " + } + }, + "DeviceTypeAndroid": { + "target": "com.amazonaws.workspaces#DefaultClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information for Android devices.

    " + } + }, + "DeviceTypeIos": { + "target": "com.amazonaws.workspaces#IosClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information for iOS devices.

    " + } + }, + "DeviceTypeLinux": { + "target": "com.amazonaws.workspaces#DefaultClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information for Linux devices.

    " + } + }, + "DeviceTypeWeb": { + "target": "com.amazonaws.workspaces#DefaultClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information for Web access.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeClientProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeClientPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeClientPropertiesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

    " + } + }, + "com.amazonaws.workspaces#DescribeClientPropertiesRequest": { + "type": "structure", + "members": { + "ResourceIds": { + "target": "com.amazonaws.workspaces#ResourceIdList", + "traits": { + "smithy.api#documentation": "

    The resource identifier, in the form of directory IDs.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DescribeClientPropertiesResult": { + "type": "structure", + "members": { + "ClientPropertiesList": { + "target": "com.amazonaws.workspaces#ClientPropertiesList", + "traits": { + "smithy.api#documentation": "

    Information about the specified Amazon WorkSpaces clients.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeConnectClientAddIns": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeConnectClientAddInsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeConnectClientAddInsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves a list of Amazon Connect client add-ins that have been created.

    " + } + }, + "com.amazonaws.workspaces#DescribeConnectClientAddInsRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The directory identifier for which the client add-in is configured.

    ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeConnectClientAddInsResult": { + "type": "structure", + "members": { + "AddIns": { + "target": "com.amazonaws.workspaces#ConnectClientAddInList", + "traits": { + "smithy.api#documentation": "

    Information about client add-ins.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeConnectionAliasPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeConnectionAliasPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeConnectionAliasPermissionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the permissions that the owner of a connection alias has granted to another\n Amazon Web Services account for the specified connection alias. For more information, see\n Cross-Region\n Redirection for Amazon WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#DescribeConnectionAliasPermissionsRequest": { + "type": "structure", + "members": { + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias.

    ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeConnectionAliasPermissionsResult": { + "type": "structure", + "members": { + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias.

    " + } + }, + "ConnectionAliasPermissions": { + "target": "com.amazonaws.workspaces#ConnectionAliasPermissions", + "traits": { + "smithy.api#documentation": "

    The permissions associated with a connection alias.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeConnectionAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeConnectionAliasesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeConnectionAliasesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves a list that describes the connection aliases used for cross-Region\n redirection. For more information, see Cross-Region\n Redirection for Amazon WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#DescribeConnectionAliasesRequest": { + "type": "structure", + "members": { + "AliasIds": { + "target": "com.amazonaws.workspaces#ConnectionAliasIdList", + "traits": { + "smithy.api#documentation": "

    The identifiers of the connection aliases to describe.

    " + } + }, + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the directory associated with the connection alias.

    " + } + }, + "Limit": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "

    The maximum number of connection aliases to return.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeConnectionAliasesResult": { + "type": "structure", + "members": { + "ConnectionAliases": { + "target": "com.amazonaws.workspaces#ConnectionAliasList", + "traits": { + "smithy.api#documentation": "

    Information about the specified connection aliases.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeIpGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeIpGroupsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeIpGroupsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes one or more of your IP access control groups.

    " + } + }, + "com.amazonaws.workspaces#DescribeIpGroupsRequest": { + "type": "structure", + "members": { + "GroupIds": { + "target": "com.amazonaws.workspaces#IpGroupIdList", + "traits": { + "smithy.api#documentation": "

    The identifiers of one or more IP access control groups.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeIpGroupsResult": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.workspaces#WorkspacesIpGroupsList", + "traits": { + "smithy.api#documentation": "

    Information about the IP access control groups.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeTagsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeTagsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the specified tags for the specified WorkSpaces resource.

    " + } + }, + "com.amazonaws.workspaces#DescribeTagsRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, IP access control groups, and connection\n aliases.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DescribeTagsResult": { + "type": "structure", + "members": { + "TagList": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

    The tags.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceBundles": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeWorkspaceBundlesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeWorkspaceBundlesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves a list that describes the available WorkSpace bundles.

    \n

    You can filter the results using either bundle ID or owner, but not both.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Bundles" + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceBundlesRequest": { + "type": "structure", + "members": { + "BundleIds": { + "target": "com.amazonaws.workspaces#BundleIdList", + "traits": { + "smithy.api#documentation": "

    The identifiers of the bundles. You cannot combine this parameter with any other filter.

    " + } + }, + "Owner": { + "target": "com.amazonaws.workspaces#BundleOwner", + "traits": { + "smithy.api#documentation": "

    The owner of the bundles. You cannot combine this parameter with any other filter.

    \n

    To describe the bundles provided by Amazon Web Services, specify AMAZON. \n To describe the bundles that belong to your account, don't specify a value.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token for the next set of results. (You received this token from a previous call.)

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceBundlesResult": { + "type": "structure", + "members": { + "Bundles": { + "target": "com.amazonaws.workspaces#BundleList", + "traits": { + "smithy.api#documentation": "

    Information about the bundles.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are no more \n results to return. This token is valid for one day and must be used within that time\n frame.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceDirectories": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeWorkspaceDirectoriesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeWorkspaceDirectoriesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the available directories that are registered with Amazon WorkSpaces.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Directories" + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceDirectoriesRequest": { + "type": "structure", + "members": { + "DirectoryIds": { + "target": "com.amazonaws.workspaces#DirectoryIdList", + "traits": { + "smithy.api#documentation": "

    The identifiers of the directories. If the value is null, all directories are\n retrieved.

    " + } + }, + "Limit": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "

    The maximum number of directories to return.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceDirectoriesResult": { + "type": "structure", + "members": { + "Directories": { + "target": "com.amazonaws.workspaces#DirectoryList", + "traits": { + "smithy.api#documentation": "

    Information about the directories.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceImagePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeWorkspaceImagePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeWorkspaceImagePermissionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.

    " + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceImagePermissionsRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the image.

    ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceImagePermissionsResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the image.

    " + } + }, + "ImagePermissions": { + "target": "com.amazonaws.workspaces#ImagePermissions", + "traits": { + "smithy.api#documentation": "

    The identifiers of the Amazon Web Services accounts that the image has been shared\n with.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeWorkspaceImagesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeWorkspaceImagesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves a list that describes one or more specified images, if the image identifiers\n are provided. Otherwise, all images in the account are described.

    " + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceImagesRequest": { + "type": "structure", + "members": { + "ImageIds": { + "target": "com.amazonaws.workspaces#WorkspaceImageIdList", + "traits": { + "smithy.api#documentation": "

    The identifier of the image.

    " + } + }, + "ImageType": { + "target": "com.amazonaws.workspaces#ImageType", + "traits": { + "smithy.api#documentation": "

    The type (owned or shared) of the image.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceImagesResult": { + "type": "structure", + "members": { + "Images": { + "target": "com.amazonaws.workspaces#WorkspaceImageList", + "traits": { + "smithy.api#documentation": "

    Information about the images.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeWorkspaceSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeWorkspaceSnapshotsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the snapshots for the specified WorkSpace.

    " + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceSnapshotsRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspaceSnapshotsResult": { + "type": "structure", + "members": { + "RebuildSnapshots": { + "target": "com.amazonaws.workspaces#SnapshotList", + "traits": { + "smithy.api#documentation": "

    Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots\n include the user volume.

    " + } + }, + "RestoreSnapshots": { + "target": "com.amazonaws.workspaces#SnapshotList", + "traits": { + "smithy.api#documentation": "

    Information about the snapshots that can be used to restore a WorkSpace. These snapshots\n include both the root volume and the user volume.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeWorkspacesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeWorkspacesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the specified WorkSpaces.

    \n

    You can filter the results by using the bundle identifier, directory identifier, or\n owner, but you can specify only one filter at a time.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Workspaces", + "pageSize": "Limit" + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspacesConnectionStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeWorkspacesConnectionStatusRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeWorkspacesConnectionStatusResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the connection status of the specified WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#DescribeWorkspacesConnectionStatusRequest": { + "type": "structure", + "members": { + "WorkspaceIds": { + "target": "com.amazonaws.workspaces#WorkspaceIdList", + "traits": { + "smithy.api#documentation": "

    The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspacesConnectionStatusResult": { + "type": "structure", + "members": { + "WorkspacesConnectionStatus": { + "target": "com.amazonaws.workspaces#WorkspaceConnectionStatusList", + "traits": { + "smithy.api#documentation": "

    Information about the connection status of the WorkSpace.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspacesRequest": { + "type": "structure", + "members": { + "WorkspaceIds": { + "target": "com.amazonaws.workspaces#WorkspaceIdList", + "traits": { + "smithy.api#documentation": "

    The identifiers of the WorkSpaces. You cannot combine this parameter with any other\n filter.

    \n

    Because the CreateWorkspaces operation is asynchronous, the identifier\n it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

    " + } + }, + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The identifier of the directory. In addition, you can optionally specify a specific\n directory user (see UserName). You cannot combine this parameter with any\n other filter.

    " + } + }, + "UserName": { + "target": "com.amazonaws.workspaces#UserName", + "traits": { + "smithy.api#documentation": "

    The name of the directory user. You must specify this parameter with\n DirectoryId.

    " + } + }, + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", + "traits": { + "smithy.api#documentation": "

    The identifier of the bundle. All WorkSpaces that are created from this bundle are\n retrieved. You cannot combine this parameter with any other filter.

    " + } + }, + "Limit": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspacesResult": { + "type": "structure", + "members": { + "Workspaces": { + "target": "com.amazonaws.workspaces#WorkspaceList", + "traits": { + "smithy.api#documentation": "

    Information about the WorkSpaces.

    \n

    Because CreateWorkspaces is an asynchronous operation, some of the\n returned information could be incomplete.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#Description": { + "type": "string" + }, + "com.amazonaws.workspaces#DirectoryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 65 + }, + "smithy.api#pattern": "^d-[0-9a-f]{8,63}$" + } + }, + "com.amazonaws.workspaces#DirectoryIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#DirectoryId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#DirectoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspaceDirectory" + } + }, + "com.amazonaws.workspaces#DirectoryName": { + "type": "string" + }, + "com.amazonaws.workspaces#DisassociateConnectionAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DisassociateConnectionAliasRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DisassociateConnectionAliasResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Disassociates a connection alias from a directory. Disassociating a connection alias\n disables cross-Region redirection between two directories in different Regions. For more\n information, see Cross-Region\n Redirection for Amazon WorkSpaces.

    \n \n

    Before performing this operation, call \n DescribeConnectionAliases to make sure that the current state of the\n connection alias is CREATED.

    \n     " + } + }, + "com.amazonaws.workspaces#DisassociateConnectionAliasRequest": { + "type": "structure", + "members": { + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias to disassociate.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DisassociateConnectionAliasResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#DisassociateIpGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DisassociateIpGroupsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DisassociateIpGroupsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Disassociates the specified IP access control group from the specified directory.

    " + } + }, + "com.amazonaws.workspaces#DisassociateIpGroupsRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The identifier of the directory.

    ", + "smithy.api#required": {} + } + }, + "GroupIds": { + "target": "com.amazonaws.workspaces#IpGroupIdList", + "traits": { + "smithy.api#documentation": "

    The identifiers of one or more IP access control groups.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DisassociateIpGroupsResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#DnsIpAddresses": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#IpAddress" + } + }, + "com.amazonaws.workspaces#Ec2ImageId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^ami\\-([a-f0-9]{8}|[a-f0-9]{17})$" + } + }, + "com.amazonaws.workspaces#ErrorType": { + "type": "string" + }, + "com.amazonaws.workspaces#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.workspaces#FailedCreateWorkspaceRequest": { + "type": "structure", + "members": { + "WorkspaceRequest": { + "target": "com.amazonaws.workspaces#WorkspaceRequest", + "traits": { + "smithy.api#documentation": "

    Information about the WorkSpace.

    " + } + }, + "ErrorCode": { + "target": "com.amazonaws.workspaces#ErrorType", + "traits": { + "smithy.api#documentation": "

    The error code that is returned if the WorkSpace cannot be created.

    " + } + }, + "ErrorMessage": { + "target": "com.amazonaws.workspaces#Description", + "traits": { + "smithy.api#documentation": "

    The text of the error message that is returned if the WorkSpace cannot be\n created.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a WorkSpace that cannot be created.

    " + } + }, + "com.amazonaws.workspaces#FailedCreateWorkspaceRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#FailedCreateWorkspaceRequest" + } + }, + "com.amazonaws.workspaces#FailedRebootWorkspaceRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#FailedWorkspaceChangeRequest" + } + }, + "com.amazonaws.workspaces#FailedRebuildWorkspaceRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#FailedWorkspaceChangeRequest" + } + }, + "com.amazonaws.workspaces#FailedStartWorkspaceRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#FailedWorkspaceChangeRequest" + } + }, + "com.amazonaws.workspaces#FailedStopWorkspaceRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#FailedWorkspaceChangeRequest" + } + }, + "com.amazonaws.workspaces#FailedTerminateWorkspaceRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#FailedWorkspaceChangeRequest" + } + }, + "com.amazonaws.workspaces#FailedWorkspaceChangeRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " + } + }, + "ErrorCode": { + "target": "com.amazonaws.workspaces#ErrorType", + "traits": { + "smithy.api#documentation": "

    The error code that is returned if the WorkSpace cannot be rebooted.

    " + } + }, + "ErrorMessage": { + "target": "com.amazonaws.workspaces#Description", + "traits": { + "smithy.api#documentation": "

    The text of the error message that is returned if the WorkSpace cannot be\n rebooted.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a WorkSpace that could not be rebooted. (RebootWorkspaces),\n rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).

    " + } + }, + "com.amazonaws.workspaces#ImagePermission": { + "type": "structure", + "members": { + "SharedAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", + "traits": { + "smithy.api#documentation": "

    The identifier of the Amazon Web Services account that an image has been shared\n with.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the Amazon Web Services accounts that have been granted permission to use a\n shared image. For more information about sharing images, see Share or Unshare a Custom\n WorkSpaces Image.

    " + } + }, + "com.amazonaws.workspaces#ImagePermissions": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ImagePermission" + } + }, + "com.amazonaws.workspaces#ImageType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OWNED", + "name": "OWNED" + }, + { + "value": "SHARED", + "name": "SHARED" + } + ] + } + }, + "com.amazonaws.workspaces#ImportClientBranding": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#ImportClientBrandingRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#ImportClientBrandingResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

    Imports client branding. Client branding allows you to customize your WorkSpace's client\n login portal. You can tailor your login portal company logo, the support email address,\n support link, link to reset password, and a custom message for users trying to sign\n in.

    \n

    After you import client branding, the default branding experience for the specified\n platform type is replaced with the imported experience

    \n \n
      \n
    • \n

      You must specify at least one platform type when importing client\n branding.

      \n
      • \n
    • \n

      You can import up to 6 MB of data with each request. If your request exceeds\n this limit, you can import client branding for different platform types using\n separate requests.

      \n
      • \n
    • \n

      In each platform type, the SupportEmail and\n SupportLink parameters are mutually exclusive. You can specify\n only one parameter for each platform type, but not both.

      \n
      • \n
    • \n

      Imported data can take up to a minute to appear in the WorkSpaces\n client.

      \n
      • \n
    \n     " + } + }, + "com.amazonaws.workspaces#ImportClientBrandingRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The directory identifier of the WorkSpace for which you want to import client\n branding.

    ", + "smithy.api#required": {} + } + }, + "DeviceTypeWindows": { + "target": "com.amazonaws.workspaces#DefaultImportClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information to import for Windows devices.

    " + } + }, + "DeviceTypeOsx": { + "target": "com.amazonaws.workspaces#DefaultImportClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information to import for macOS devices.

    " + } + }, + "DeviceTypeAndroid": { + "target": "com.amazonaws.workspaces#DefaultImportClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information to import for Android devices.

    " + } + }, + "DeviceTypeIos": { + "target": "com.amazonaws.workspaces#IosImportClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information to import for iOS devices.

    " + } + }, + "DeviceTypeLinux": { + "target": "com.amazonaws.workspaces#DefaultImportClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information to import for Linux devices.

    " + } + }, + "DeviceTypeWeb": { + "target": "com.amazonaws.workspaces#DefaultImportClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information to import for web access.

    " + } + } + } + }, + "com.amazonaws.workspaces#ImportClientBrandingResult": { + "type": "structure", + "members": { + "DeviceTypeWindows": { + "target": "com.amazonaws.workspaces#DefaultClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information configured for Windows devices.

    " + } + }, + "DeviceTypeOsx": { + "target": "com.amazonaws.workspaces#DefaultClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information configured for macOS devices.

    " + } + }, + "DeviceTypeAndroid": { + "target": "com.amazonaws.workspaces#DefaultClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information configured for Android devices.

    " + } + }, + "DeviceTypeIos": { + "target": "com.amazonaws.workspaces#IosClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information configured for iOS devices.

    " + } + }, + "DeviceTypeLinux": { + "target": "com.amazonaws.workspaces#DefaultClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information configured for Linux devices.

    " + } + }, + "DeviceTypeWeb": { + "target": "com.amazonaws.workspaces#DefaultClientBrandingAttributes", + "traits": { + "smithy.api#documentation": "

    The branding information configured for web access.

    " + } + } + } + }, + "com.amazonaws.workspaces#ImportWorkspaceImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#ImportWorkspaceImageRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#ImportWorkspaceImageResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon\n WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL\n images, see Bring Your Own Windows\n Desktop Licenses.

    " + } + }, + "com.amazonaws.workspaces#ImportWorkspaceImageRequest": { + "type": "structure", + "members": { + "Ec2ImageId": { + "target": "com.amazonaws.workspaces#Ec2ImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the EC2 image.

    ", + "smithy.api#required": {} + } + }, + "IngestionProcess": { + "target": "com.amazonaws.workspaces#WorkspaceImageIngestionProcess", + "traits": { + "smithy.api#documentation": "

    The ingestion process to be used when importing the image, depending on which protocol\n you want to use for your BYOL Workspace image, either PCoIP or WorkSpaces Streaming\n Protocol (WSP). To use WSP, specify a value that ends in _WSP. To use PCoIP,\n specify a value that does not end in _WSP.

    \n

    For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify\n BYOL_REGULAR or BYOL_REGULAR_WSP, depending on the\n protocol.

    ", + "smithy.api#required": {} + } + }, + "ImageName": { + "target": "com.amazonaws.workspaces#WorkspaceImageName", + "traits": { + "smithy.api#documentation": "

    The name of the WorkSpace image.

    ", + "smithy.api#required": {} + } + }, + "ImageDescription": { + "target": "com.amazonaws.workspaces#WorkspaceImageDescription", + "traits": { + "smithy.api#documentation": "

    The description of the WorkSpace image.

    ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    " + } + }, + "Applications": { + "target": "com.amazonaws.workspaces#ApplicationList", + "traits": { + "smithy.api#documentation": "

    If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10\n BYOL images. For more information about subscribing to Office for BYOL images, see Bring\n Your Own Windows Desktop Licenses.

    \n \n

    Although this parameter is an array, only one item is allowed at this time.

    \n     " + } + } + } + }, + "com.amazonaws.workspaces#ImportWorkspaceImageResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpace image.

    " + } + } + } + }, + "com.amazonaws.workspaces#InvalidParameterValuesException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

    The exception error message.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    One or more parameter values are not valid.

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#InvalidResourceStateException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The state of the resource is not valid for this operation.

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#Ios2XLogo": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1770000 + } + } + }, + "com.amazonaws.workspaces#Ios3XLogo": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1770000 + } + } + }, + "com.amazonaws.workspaces#IosClientBrandingAttributes": { + "type": "structure", + "members": { + "LogoUrl": { + "target": "com.amazonaws.workspaces#ClientUrl", + "traits": { + "smithy.api#documentation": "

    The logo. This is the link where users can download the logo image. This is the\n standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal\n to one point.

    " + } + }, + "Logo2xUrl": { + "target": "com.amazonaws.workspaces#ClientUrl", + "traits": { + "smithy.api#documentation": "

    The @2x version of the logo. This is the higher resolution display that offers a scale\n factor of 2.0 (or @2x).

    \n \n

    For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface\n Guidelines.

    \n     " + } + }, + "Logo3xUrl": { + "target": "com.amazonaws.workspaces#ClientUrl", + "traits": { + "smithy.api#documentation": "

    The @3x version of the logo. This is the higher resolution display that offers a scale\n factor of 3.0 (or @3x).

    \n \n

    For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface\n Guidelines.

    \n     " + } + }, + "SupportEmail": { + "target": "com.amazonaws.workspaces#ClientEmail", + "traits": { + "smithy.api#documentation": "

    The support email. The company's customer support email address.

    \n \n
      \n
    • \n

      In each platform type, the SupportEmail and\n SupportLink parameters are mutually exclusive. You can specify one\n parameter for each platform type, but not both.

      \n
      • \n
    • \n

      The default email is workspaces-feedback@amazon.com.

      \n
      • \n
    \n     " + } + }, + "SupportLink": { + "target": "com.amazonaws.workspaces#ClientUrl", + "traits": { + "smithy.api#documentation": "

    The support link. The link for the company's customer support page for their\n WorkSpace.

    \n \n
      \n
    • \n

      In each platform type, the SupportEmail and\n SupportLink parameters are mutually exclusive. You can specify one\n parameter for each platform type, but not both.

      \n
      • \n
    • \n

      The default support link is workspaces-feedback@amazon.com.

      \n
      • \n
    \n     " + } + }, + "ForgotPasswordLink": { + "target": "com.amazonaws.workspaces#ClientUrl", + "traits": { + "smithy.api#documentation": "

    The forgotten password link. This is the web address that users can go to if they forget\n the password for their WorkSpace.

    " + } + }, + "LoginMessage": { + "target": "com.amazonaws.workspaces#LoginMessage", + "traits": { + "smithy.api#documentation": "

    The login message. Specified as a key value pair, in which the key is a locale and the\n value is the localized message for that locale. The only key supported is\n en_US.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The client branding attributes for iOS device types. These attributes are displayed on\n the iOS client login screen only.

    \n \n

    Client branding attributes are public facing. Ensure you do not include sensitive\n information.

    \n     " + } + }, + "com.amazonaws.workspaces#IosImportClientBrandingAttributes": { + "type": "structure", + "members": { + "Logo": { + "target": "com.amazonaws.workspaces#IosLogo", + "traits": { + "smithy.api#documentation": "

    The logo. This is the link where users can download the logo image. This is the\n standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal\n to one point.

    " + } + }, + "Logo2x": { + "target": "com.amazonaws.workspaces#Ios2XLogo", + "traits": { + "smithy.api#documentation": "

    The @2x version of the logo. This is the higher resolution display that offers a scale\n factor of 2.0 (or @2x).

    \n \n

    For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface\n Guidelines.

    \n     " + } + }, + "Logo3x": { + "target": "com.amazonaws.workspaces#Ios3XLogo", + "traits": { + "smithy.api#documentation": "

    The @3x version of the logo. This is the higher resolution display that offers a scale\n factor of 3.0 (or @3x).

    \n \n

    For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface\n Guidelines.

    \n     " + } + }, + "SupportEmail": { + "target": "com.amazonaws.workspaces#ClientEmail", + "traits": { + "smithy.api#documentation": "

    The support email. The company's customer support email address.

    \n \n
      \n
    • \n

      In each platform type, the SupportEmail and\n SupportLink parameters are mutually exclusive. You can specify one\n parameter for each platform type, but not both.

      \n
      • \n
    • \n

      The default email is workspaces-feedback@amazon.com.

      \n
      • \n
    \n     " + } + }, + "SupportLink": { + "target": "com.amazonaws.workspaces#ClientUrl", + "traits": { + "smithy.api#documentation": "

    The support link. The link for the company's customer support page for their\n WorkSpace.

    \n \n
      \n
    • \n

      In each platform type, the SupportEmail and\n SupportLink parameters are mutually exclusive. You can specify one\n parameter for each platform type, but not both.

      \n
      • \n
    • \n

      The default support link is workspaces-feedback@amazon.com.

      \n
      • \n
    \n     " + } + }, + "ForgotPasswordLink": { + "target": "com.amazonaws.workspaces#ClientUrl", + "traits": { + "smithy.api#documentation": "

    The forgotten password link. This is the web address that users can go to if they forget\n the password for their WorkSpace.

    " + } + }, + "LoginMessage": { + "target": "com.amazonaws.workspaces#LoginMessage", + "traits": { + "smithy.api#documentation": "

    The login message. Specified as a key value pair, in which the key is a locale and the\n value is the localized message for that locale. The only key supported is\n en_US.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The client branding attributes to import for iOS device types. These attributes are\n displayed on the iOS client login screen.

    \n \n

    Client branding attributes are public facing. Ensure you do not include sensitive\n information.

    \n     " + } + }, + "com.amazonaws.workspaces#IosLogo": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 447000 + } + } + }, + "com.amazonaws.workspaces#IpAddress": { + "type": "string" + }, + "com.amazonaws.workspaces#IpGroupDesc": { + "type": "string" + }, + "com.amazonaws.workspaces#IpGroupId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^wsipg-[0-9a-z]{8,63}$" + } + }, + "com.amazonaws.workspaces#IpGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#IpGroupId" + } + }, + "com.amazonaws.workspaces#IpGroupName": { + "type": "string" + }, + "com.amazonaws.workspaces#IpRevokedRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#IpRule" + } + }, + "com.amazonaws.workspaces#IpRule": { + "type": "string" + }, + "com.amazonaws.workspaces#IpRuleDesc": { + "type": "string" + }, + "com.amazonaws.workspaces#IpRuleItem": { + "type": "structure", + "members": { + "ipRule": { + "target": "com.amazonaws.workspaces#IpRule", + "traits": { + "smithy.api#documentation": "

    The IP address range, in CIDR notation.

    " + } + }, + "ruleDesc": { + "target": "com.amazonaws.workspaces#IpRuleDesc", + "traits": { + "smithy.api#documentation": "

    The description.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a rule for an IP access control group.

    " + } + }, + "com.amazonaws.workspaces#IpRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#IpRuleItem" + } + }, + "com.amazonaws.workspaces#Limit": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#ListAvailableManagementCidrRanges": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#ListAvailableManagementCidrRangesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#ListAvailableManagementCidrRangesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use\n for the network management interface when you enable Bring Your Own License (BYOL).

    \n

    This operation can be run only by Amazon Web Services accounts that are enabled for BYOL.\n If your account isn't enabled for BYOL, you'll receive an\n AccessDeniedException error.

    \n

    The management network interface is connected to a secure Amazon WorkSpaces management\n network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces\n clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

    " + } + }, + "com.amazonaws.workspaces#ListAvailableManagementCidrRangesRequest": { + "type": "structure", + "members": { + "ManagementCidrRangeConstraint": { + "target": "com.amazonaws.workspaces#ManagementCidrRangeConstraint", + "traits": { + "smithy.api#documentation": "

    The IP address range to search. Specify an IP address range that is compatible with your\n network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).

    ", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.workspaces#ManagementCidrRangeMaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + } + } + } + }, + "com.amazonaws.workspaces#ListAvailableManagementCidrRangesResult": { + "type": "structure", + "members": { + "ManagementCidrRanges": { + "target": "com.amazonaws.workspaces#DedicatedTenancyCidrRangeList", + "traits": { + "smithy.api#documentation": "

    The list of available IP address ranges, specified as IPv4 CIDR blocks.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

    " + } + } + } + }, + "com.amazonaws.workspaces#LoginMessage": { + "type": "map", + "key": { + "target": "com.amazonaws.workspaces#ClientLocale" + }, + "value": { + "target": "com.amazonaws.workspaces#ClientLoginMessage" + } + }, + "com.amazonaws.workspaces#ManagementCidrRangeConstraint": { + "type": "string", + "traits": { + "smithy.api#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]))$" + } + }, + "com.amazonaws.workspaces#ManagementCidrRangeMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.workspaces#MigrateWorkspace": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#MigrateWorkspaceRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#MigrateWorkspaceResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationInProgressException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspaces#ResourceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

    Migrates a WorkSpace from one operating system or bundle type to another, while\n retaining the data on the user volume.

    \n

    The migration process recreates the WorkSpace by using a new root volume from the target\n bundle image and the user volume from the last available snapshot of the original\n WorkSpace. During migration, the original D:\\Users\\%USERNAME% user profile\n folder is renamed to D:\\Users\\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new\n D:\\Users\\%USERNAME%\\ folder is generated by the new OS. Certain files in\n the old user profile are moved to the new user profile.

    \n

    For available migration scenarios, details about what happens during migration, and best\n practices, see Migrate a\n WorkSpace.

    " + } + }, + "com.amazonaws.workspaces#MigrateWorkspaceRequest": { + "type": "structure", + "members": { + "SourceWorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpace to migrate from.

    ", + "smithy.api#required": {} + } + }, + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", + "traits": { + "smithy.api#documentation": "

    The identifier of the target bundle type to migrate the WorkSpace to.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#MigrateWorkspaceResult": { + "type": "structure", + "members": { + "SourceWorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The original identifier of the WorkSpace that is being migrated.

    " + } + }, + "TargetWorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The new identifier of the WorkSpace that is being migrated. If the migration does not\n succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the\n original WorkSpace ID.

    " + } + } + } + }, + "com.amazonaws.workspaces#ModificationResourceEnum": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ROOT_VOLUME", + "name": "ROOT_VOLUME" + }, + { + "value": "USER_VOLUME", + "name": "USER_VOLUME" + }, + { + "value": "COMPUTE_TYPE", + "name": "COMPUTE_TYPE" + } + ] + } + }, + "com.amazonaws.workspaces#ModificationState": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.workspaces#ModificationResourceEnum", + "traits": { + "smithy.api#documentation": "

    The resource.

    " + } + }, + "State": { + "target": "com.amazonaws.workspaces#ModificationStateEnum", + "traits": { + "smithy.api#documentation": "

    The modification state.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a WorkSpace modification.

    " + } + }, + "com.amazonaws.workspaces#ModificationStateEnum": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UPDATE_INITIATED", + "name": "UPDATE_INITIATED" + }, + { + "value": "UPDATE_IN_PROGRESS", + "name": "UPDATE_IN_PROGRESS" + } + ] + } + }, + "com.amazonaws.workspaces#ModificationStateList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ModificationState" + } + }, + "com.amazonaws.workspaces#ModifyAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#ModifyAccountRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#ModifyAccountResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspaces#ResourceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

    Modifies the configuration of Bring Your Own License (BYOL) for the specified\n account.

    " + } + }, + "com.amazonaws.workspaces#ModifyAccountRequest": { + "type": "structure", + "members": { + "DedicatedTenancySupport": { + "target": "com.amazonaws.workspaces#DedicatedTenancySupportEnum", + "traits": { + "smithy.api#documentation": "

    The status of BYOL.

    " + } + }, + "DedicatedTenancyManagementCidrRange": { + "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange", + "traits": { + "smithy.api#documentation": "

    The IP address range, specified as an IPv4 CIDR block, for the management network\n interface. Specify an IP address range that is compatible with your network and in CIDR\n notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be\n /16 (for example, 203.0.113.25/16). It must also be specified as available by the\n ListAvailableManagementCidrRanges operation.

    " + } + } + } + }, + "com.amazonaws.workspaces#ModifyAccountResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#ModifyClientProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#ModifyClientPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#ModifyClientPropertiesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Modifies the properties of the specified Amazon WorkSpaces clients.

    " + } + }, + "com.amazonaws.workspaces#ModifyClientPropertiesRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The resource identifiers, in the form of directory IDs.

    ", + "smithy.api#required": {} + } + }, + "ClientProperties": { + "target": "com.amazonaws.workspaces#ClientProperties", + "traits": { + "smithy.api#documentation": "

    Information about the Amazon WorkSpaces client.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#ModifyClientPropertiesResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#ModifySelfservicePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#ModifySelfservicePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#ModifySelfservicePermissionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Modifies the self-service WorkSpace management capabilities for your users. For more\n information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

    " + } + }, + "com.amazonaws.workspaces#ModifySelfservicePermissionsRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The identifier of the directory.

    ", + "smithy.api#required": {} + } + }, + "SelfservicePermissions": { + "target": "com.amazonaws.workspaces#SelfservicePermissions", + "traits": { + "smithy.api#documentation": "

    The permissions to enable or disable self-service capabilities.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#ModifySelfservicePermissionsResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#ModifyWorkspaceAccessProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#ModifyWorkspaceAccessPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#ModifyWorkspaceAccessPropertiesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Specifies which devices and operating systems users can use to access their WorkSpaces.\n For more information, see \n Control Device Access.

    " + } + }, + "com.amazonaws.workspaces#ModifyWorkspaceAccessPropertiesRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The identifier of the directory.

    ", + "smithy.api#required": {} + } + }, + "WorkspaceAccessProperties": { + "target": "com.amazonaws.workspaces#WorkspaceAccessProperties", + "traits": { + "smithy.api#documentation": "

    The device types and operating systems to enable or disable for access.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#ModifyWorkspaceAccessPropertiesResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#ModifyWorkspaceCreationProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#ModifyWorkspaceCreationPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#ModifyWorkspaceCreationPropertiesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Modify the default properties used to create WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#ModifyWorkspaceCreationPropertiesRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The identifier of the directory.

    ", + "smithy.api#required": {} + } + }, + "WorkspaceCreationProperties": { + "target": "com.amazonaws.workspaces#WorkspaceCreationProperties", + "traits": { + "smithy.api#documentation": "

    The default properties for creating WorkSpaces.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#ModifyWorkspaceCreationPropertiesResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#ModifyWorkspaceProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#ModifyWorkspacePropertiesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#ModifyWorkspacePropertiesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationInProgressException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspaces#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.workspaces#UnsupportedWorkspaceConfigurationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Modifies the specified WorkSpace properties. For important information about how to\n modify the size of the root and user volumes, see Modify a WorkSpace.\n

    " + } + }, + "com.amazonaws.workspaces#ModifyWorkspacePropertiesRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", + "smithy.api#required": {} + } + }, + "WorkspaceProperties": { + "target": "com.amazonaws.workspaces#WorkspaceProperties", + "traits": { + "smithy.api#documentation": "

    The properties of the WorkSpace.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#ModifyWorkspacePropertiesResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#ModifyWorkspaceState": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#ModifyWorkspaceStateRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#ModifyWorkspaceStateResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Sets the state of the specified WorkSpace.

    \n

    To maintain a WorkSpace without being interrupted, set the WorkSpace state to\n ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to\n reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not\n stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE\n state.

    " + } + }, + "com.amazonaws.workspaces#ModifyWorkspaceStateRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", + "smithy.api#required": {} + } + }, + "WorkspaceState": { + "target": "com.amazonaws.workspaces#TargetWorkspaceState", + "traits": { + "smithy.api#documentation": "

    The WorkSpace state.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#ModifyWorkspaceStateResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.workspaces#OperatingSystem": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.workspaces#OperatingSystemType", + "traits": { + "smithy.api#documentation": "

    The operating system.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The operating system that the image is running.

    " + } + }, + "com.amazonaws.workspaces#OperatingSystemType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WINDOWS", + "name": "WINDOWS" + }, + { + "value": "LINUX", + "name": "LINUX" + } + ] + } + }, + "com.amazonaws.workspaces#OperationInProgressException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The properties of this WorkSpace are currently being modified. Try again in a moment.

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#OperationNotSupportedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    This operation is not supported.

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.workspaces#RebootRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the information used to reboot a WorkSpace.

    " + } + }, + "com.amazonaws.workspaces#RebootWorkspaceRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#RebootRequest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#RebootWorkspaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#RebootWorkspacesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#RebootWorkspacesResult" + }, + "traits": { + "smithy.api#documentation": "

    Reboots the specified WorkSpaces.

    \n

    You cannot reboot a WorkSpace unless its state is AVAILABLE or\n UNHEALTHY.

    \n

    This operation is asynchronous and returns before the WorkSpaces have rebooted.

    " + } + }, + "com.amazonaws.workspaces#RebootWorkspacesRequest": { + "type": "structure", + "members": { + "RebootWorkspaceRequests": { + "target": "com.amazonaws.workspaces#RebootWorkspaceRequests", + "traits": { + "smithy.api#documentation": "

    The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#RebootWorkspacesResult": { + "type": "structure", + "members": { + "FailedRequests": { + "target": "com.amazonaws.workspaces#FailedRebootWorkspaceRequests", + "traits": { + "smithy.api#documentation": "

    Information about the WorkSpaces that could not be rebooted.

    " + } + } + } + }, + "com.amazonaws.workspaces#RebuildRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the information used to rebuild a WorkSpace.

    " + } + }, + "com.amazonaws.workspaces#RebuildWorkspaceRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#RebuildRequest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.workspaces#RebuildWorkspaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#RebuildWorkspacesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#RebuildWorkspacesResult" + }, + "traits": { + "smithy.api#documentation": "

    Rebuilds the specified WorkSpace.

    \n

    You cannot rebuild a WorkSpace unless its state is AVAILABLE,\n ERROR, UNHEALTHY, STOPPED, or\n REBOOTING.

    \n

    Rebuilding a WorkSpace is a potentially destructive action that can result in the loss\n of data. For more information, see Rebuild a\n WorkSpace.

    \n

    This operation is asynchronous and returns before the WorkSpaces have been completely\n rebuilt.

    " + } + }, + "com.amazonaws.workspaces#RebuildWorkspacesRequest": { + "type": "structure", + "members": { + "RebuildWorkspaceRequests": { + "target": "com.amazonaws.workspaces#RebuildWorkspaceRequests", + "traits": { + "smithy.api#documentation": "

    The WorkSpace to rebuild. You can specify a single WorkSpace.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#RebuildWorkspacesResult": { + "type": "structure", + "members": { + "FailedRequests": { + "target": "com.amazonaws.workspaces#FailedRebuildWorkspaceRequests", + "traits": { + "smithy.api#documentation": "

    Information about the WorkSpace that could not be rebuilt.

    " + } + } + } + }, + "com.amazonaws.workspaces#ReconnectEnum": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, + "com.amazonaws.workspaces#Region": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 31 + }, + "smithy.api#pattern": "^[-0-9a-z]{1,31}$" + } + }, + "com.amazonaws.workspaces#RegisterWorkspaceDirectory": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#RegisterWorkspaceDirectoryRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#RegisterWorkspaceDirectoryResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspaces#UnsupportedNetworkConfigurationException" + }, + { + "target": "com.amazonaws.workspaces#WorkspacesDefaultRoleNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Registers the specified directory. This operation is asynchronous and returns before the\n WorkSpace directory is registered. If this is the first time you are registering a\n directory, you will need to create the workspaces_DefaultRole role before you can register\n a directory. For more information, see \n Creating the workspaces_DefaultRole Role.

    " + } + }, + "com.amazonaws.workspaces#RegisterWorkspaceDirectoryRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The identifier of the directory. You cannot register a directory if it does not have a\n status of Active. If the directory does not have a status of Active, you will receive an\n InvalidResourceStateException error. If you have already registered the maximum number of\n directories that you can register with Amazon WorkSpaces, you will receive a\n ResourceLimitExceededException error. Deregister directories that you are not using for\n WorkSpaces, and try again.

    ", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.workspaces#SubnetIds", + "traits": { + "smithy.api#documentation": "

    The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the\n subnets are in supported Availability Zones. The subnets must also be in separate\n Availability Zones. If these conditions are not met, you will receive an\n OperationNotSupportedException error.

    " + } + }, + "EnableWorkDocs": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this\n parameter and WorkDocs is not available in the Region, you will receive an\n OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try\n again.

    ", + "smithy.api#required": {} + } + }, + "EnableSelfService": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether self-service capabilities are enabled or disabled.

    " + } + }, + "Tenancy": { + "target": "com.amazonaws.workspaces#Tenancy", + "traits": { + "smithy.api#documentation": "

    Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own\n License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for\n BYOL, you will receive an InvalidParameterValuesException error. For more information about\n BYOL images, see Bring Your Own Windows\n Desktop Images.

    " + } + }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

    The tags associated with the directory.

    " + } + } + } + }, + "com.amazonaws.workspaces#RegisterWorkspaceDirectoryResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#RegistrationCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.workspaces#ResourceAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The specified resource already exists.

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#ResourceAssociatedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The resource is associated with a directory.

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#ResourceCreationFailedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The resource could not be created.

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#ResourceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#ResourceLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

    The exception error message.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Your resource limits have been exceeded.

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

    The resource could not be found.

    " + } + }, + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the resource that could not be found.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The resource could not be found.

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#ResourceUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

    The exception error message.

    " + } + }, + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the resource that is not available.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The specified resource is not available.

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#RestoreWorkspace": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#RestoreWorkspaceRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#RestoreWorkspaceResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Restores the specified WorkSpace to its last known healthy state.

    \n

    You cannot restore a WorkSpace unless its state is AVAILABLE,\n ERROR, UNHEALTHY, or STOPPED.

    \n

    Restoring a WorkSpace is a potentially destructive action that can result in the loss of\n data. For more information, see Restore a\n WorkSpace.

    \n

    This operation is asynchronous and returns before the WorkSpace is completely\n restored.

    " + } + }, + "com.amazonaws.workspaces#RestoreWorkspaceRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#RestoreWorkspaceResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#RevokeIpRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#RevokeIpRulesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#RevokeIpRulesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Removes one or more rules from the specified IP access control group.

    " + } + }, + "com.amazonaws.workspaces#RevokeIpRulesRequest": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.workspaces#IpGroupId", + "traits": { + "smithy.api#documentation": "

    The identifier of the group.

    ", + "smithy.api#required": {} + } + }, + "UserRules": { + "target": "com.amazonaws.workspaces#IpRevokedRuleList", + "traits": { + "smithy.api#documentation": "

    The rules to remove from the group.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#RevokeIpRulesResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#RootStorage": { + "type": "structure", + "members": { + "Capacity": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The size of the root volume.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the root volume for a WorkSpace bundle.

    " + } + }, + "com.amazonaws.workspaces#RootVolumeSizeGib": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.workspaces#RunningMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AUTO_STOP", + "name": "AUTO_STOP" + }, + { + "value": "ALWAYS_ON", + "name": "ALWAYS_ON" + } + ] + } + }, + "com.amazonaws.workspaces#RunningModeAutoStopTimeoutInMinutes": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.workspaces#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 11, + "max": 20 + }, + "smithy.api#pattern": "^(sg-([0-9a-f]{8}|[0-9a-f]{17}))$" + } + }, + "com.amazonaws.workspaces#SelfservicePermissions": { + "type": "structure", + "members": { + "RestartWorkspace": { + "target": "com.amazonaws.workspaces#ReconnectEnum", + "traits": { + "smithy.api#documentation": "

    Specifies whether users can restart their WorkSpace.

    " + } + }, + "IncreaseVolumeSize": { + "target": "com.amazonaws.workspaces#ReconnectEnum", + "traits": { + "smithy.api#documentation": "

    Specifies whether users can increase the volume size of the drives on their\n WorkSpace.

    " + } + }, + "ChangeComputeType": { + "target": "com.amazonaws.workspaces#ReconnectEnum", + "traits": { + "smithy.api#documentation": "

    Specifies whether users can change the compute type (bundle) for their WorkSpace.

    " + } + }, + "SwitchRunningMode": { + "target": "com.amazonaws.workspaces#ReconnectEnum", + "traits": { + "smithy.api#documentation": "

    Specifies whether users can switch the running mode of their WorkSpace.

    " + } + }, + "RebuildWorkspace": { + "target": "com.amazonaws.workspaces#ReconnectEnum", + "traits": { + "smithy.api#documentation": "

    Specifies whether users can rebuild the operating system of a WorkSpace to its original\n state.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

    " + } + }, + "com.amazonaws.workspaces#Snapshot": { + "type": "structure", + "members": { + "SnapshotTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time when the snapshot was created.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a snapshot.

    " + } + }, + "com.amazonaws.workspaces#SnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#Snapshot" + } + }, + "com.amazonaws.workspaces#StartRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information used to start a WorkSpace.

    " + } + }, + "com.amazonaws.workspaces#StartWorkspaceRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#StartRequest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#StartWorkspaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#StartWorkspacesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#StartWorkspacesResult" + }, + "traits": { + "smithy.api#documentation": "

    Starts the specified WorkSpaces.

    \n

    You cannot start a WorkSpace unless it has a running mode of AutoStop and a\n state of STOPPED.

    " + } + }, + "com.amazonaws.workspaces#StartWorkspacesRequest": { + "type": "structure", + "members": { + "StartWorkspaceRequests": { + "target": "com.amazonaws.workspaces#StartWorkspaceRequests", + "traits": { + "smithy.api#documentation": "

    The WorkSpaces to start. You can specify up to 25 WorkSpaces.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#StartWorkspacesResult": { + "type": "structure", + "members": { + "FailedRequests": { + "target": "com.amazonaws.workspaces#FailedStartWorkspaceRequests", + "traits": { + "smithy.api#documentation": "

    Information about the WorkSpaces that could not be started.

    " + } + } + } + }, + "com.amazonaws.workspaces#StopRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the information used to stop a WorkSpace.

    " + } + }, + "com.amazonaws.workspaces#StopWorkspaceRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#StopRequest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#StopWorkspaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#StopWorkspacesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#StopWorkspacesResult" + }, + "traits": { + "smithy.api#documentation": "

    Stops the specified WorkSpaces.

    \n

    You cannot stop a WorkSpace unless it has a running mode of AutoStop and a\n state of AVAILABLE, IMPAIRED, UNHEALTHY, or\n ERROR.

    " + } + }, + "com.amazonaws.workspaces#StopWorkspacesRequest": { + "type": "structure", + "members": { + "StopWorkspaceRequests": { + "target": "com.amazonaws.workspaces#StopWorkspaceRequests", + "traits": { + "smithy.api#documentation": "

    The WorkSpaces to stop. You can specify up to 25 WorkSpaces.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#StopWorkspacesResult": { + "type": "structure", + "members": { + "FailedRequests": { + "target": "com.amazonaws.workspaces#FailedStopWorkspaceRequests", + "traits": { + "smithy.api#documentation": "

    Information about the WorkSpaces that could not be stopped.

    " + } + } + } + }, + "com.amazonaws.workspaces#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 24 + }, + "smithy.api#pattern": "^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$" + } + }, + "com.amazonaws.workspaces#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.workspaces#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.workspaces#TagKey", + "traits": { + "smithy.api#documentation": "

    The key of the tag.

    ", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.workspaces#TagValue", + "traits": { + "smithy.api#documentation": "

    The value of the tag.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a tag.

    " + } + }, + "com.amazonaws.workspaces#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + } + } + }, + "com.amazonaws.workspaces#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#NonEmptyString" + } + }, + "com.amazonaws.workspaces#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#Tag" + } + }, + "com.amazonaws.workspaces#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.workspaces#TargetWorkspaceState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "ADMIN_MAINTENANCE", + "name": "ADMIN_MAINTENANCE" + } + ] + } + }, + "com.amazonaws.workspaces#Tenancy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DEDICATED", + "name": "DEDICATED" + }, + { + "value": "SHARED", + "name": "SHARED" + } + ] + } + }, + "com.amazonaws.workspaces#TerminateRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the information used to terminate a WorkSpace.

    " + } + }, + "com.amazonaws.workspaces#TerminateWorkspaceRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#TerminateRequest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#TerminateWorkspaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#TerminateWorkspacesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#TerminateWorkspacesResult" + }, + "traits": { + "smithy.api#documentation": "

    Terminates the specified WorkSpaces.

    \n \n

    Terminating a WorkSpace is a permanent action and cannot be undone. The user's data\n is destroyed. If you need to archive any user data, contact Amazon Web Services Support before\n terminating the WorkSpace.

    \n     \n

    You can terminate a WorkSpace that is in any state except SUSPENDED.

    \n

    This operation is asynchronous and returns before the WorkSpaces have been completely\n terminated. After a WorkSpace is terminated, the TERMINATED state is returned\n only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely\n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using\n \n DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has\n been successfully terminated.

    \n \n

    Simple AD and AD Connector are made available to you free of charge to use with\n WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector\n directory for 30 consecutive days, this directory will be automatically deregistered for\n use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing\n terms.

    \n

    To delete empty directories, see Delete the\n Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector\n directory, you can always create a new one when you want to start using WorkSpaces\n again.

    \n     " + } + }, + "com.amazonaws.workspaces#TerminateWorkspacesRequest": { + "type": "structure", + "members": { + "TerminateWorkspaceRequests": { + "target": "com.amazonaws.workspaces#TerminateWorkspaceRequests", + "traits": { + "smithy.api#documentation": "

    The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#TerminateWorkspacesResult": { + "type": "structure", + "members": { + "FailedRequests": { + "target": "com.amazonaws.workspaces#FailedTerminateWorkspaceRequests", + "traits": { + "smithy.api#documentation": "

    Information about the WorkSpaces that could not be terminated.

    " + } + } + } + }, + "com.amazonaws.workspaces#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.workspaces#UnsupportedNetworkConfigurationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The configuration of this network is not supported for this operation, or your network configuration \n conflicts with the Amazon WorkSpaces management network IP range. For more information, see \n \n Configure a VPC for Amazon WorkSpaces.

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#UnsupportedWorkspaceConfigurationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The configuration of this WorkSpace is not supported for this operation. For more information, see \n Required \n Configuration and Service Components for WorkSpaces .

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#UpdateConnectClientAddIn": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#UpdateConnectClientAddInRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#UpdateConnectClientAddInResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Updates a Amazon Connect client add-in. Use this action to update the name and\n endpoint URL of a Amazon Connect client add-in.

    " + } + }, + "com.amazonaws.workspaces#UpdateConnectClientAddInRequest": { + "type": "structure", + "members": { + "AddInId": { + "target": "com.amazonaws.workspaces#AmazonUuid", + "traits": { + "smithy.api#documentation": "

    The identifier of the client add-in to update.

    ", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The directory identifier for which the client add-in is configured.

    ", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.workspaces#AddInName", + "traits": { + "smithy.api#documentation": "

    The name of the client add-in.

    " + } + }, + "URL": { + "target": "com.amazonaws.workspaces#AddInUrl", + "traits": { + "smithy.api#documentation": "

    The endpoint URL of the Amazon Connect client add-in.

    " + } + } + } + }, + "com.amazonaws.workspaces#UpdateConnectClientAddInResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#UpdateConnectionAliasPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#UpdateConnectionAliasPermissionRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#UpdateConnectionAliasPermissionResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAssociatedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Shares or unshares a connection alias with one account by specifying whether that\n account has permission to associate the connection alias with a directory. If the\n association permission is granted, the connection alias is shared with that account. If the\n association permission is revoked, the connection alias is unshared with the account. For\n more information, see Cross-Region\n Redirection for Amazon WorkSpaces.

    \n \n
      \n
    • \n

      Before performing this operation, call \n DescribeConnectionAliases to make sure that the current state of the\n connection alias is CREATED.

      \n
      • \n
    • \n

      To delete a connection alias that has been shared, the shared account must\n first disassociate the connection alias from any directories it has been\n associated with. Then you must unshare the connection alias from the account it\n has been shared with. You can delete a connection alias only after it is no longer\n shared with any accounts or associated with any directories.

      \n
      • \n
    \n     " + } + }, + "com.amazonaws.workspaces#UpdateConnectionAliasPermissionRequest": { + "type": "structure", + "members": { + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias that you want to update permissions for.

    ", + "smithy.api#required": {} + } + }, + "ConnectionAliasPermission": { + "target": "com.amazonaws.workspaces#ConnectionAliasPermission", + "traits": { + "smithy.api#documentation": "

    Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#UpdateConnectionAliasPermissionResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#UpdateDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_./() -]+$" + } + }, + "com.amazonaws.workspaces#UpdateResult": { + "type": "structure", + "members": { + "UpdateAvailable": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether updated drivers or other components are available for the specified\n WorkSpace image.

    " + } + }, + "Description": { + "target": "com.amazonaws.workspaces#UpdateDescription", + "traits": { + "smithy.api#documentation": "

    A description of whether updates for the WorkSpace image are pending or\n available.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes whether a WorkSpace image needs to be updated with the latest drivers and\n other components required by Amazon WorkSpaces.

    \n \n

    Only Windows 10 WorkSpace images can be programmatically updated at this time.

    \n     " + } + }, + "com.amazonaws.workspaces#UpdateRulesOfIpGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#UpdateRulesOfIpGroupRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#UpdateRulesOfIpGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Replaces the current rules of the specified IP access control group with the specified\n rules.

    " + } + }, + "com.amazonaws.workspaces#UpdateRulesOfIpGroupRequest": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.workspaces#IpGroupId", + "traits": { + "smithy.api#documentation": "

    The identifier of the group.

    ", + "smithy.api#required": {} + } + }, + "UserRules": { + "target": "com.amazonaws.workspaces#IpRuleList", + "traits": { + "smithy.api#documentation": "

    One or more rules.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#UpdateRulesOfIpGroupResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#UpdateWorkspaceBundle": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#UpdateWorkspaceBundleRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#UpdateWorkspaceBundleResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspaces#ResourceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

    Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see \n \n Update a Custom WorkSpaces Bundle.

    \n \n \n

    Existing WorkSpaces aren't automatically updated when you update the bundle that they're \n based on. To update existing WorkSpaces that are based on a bundle that you've updated, you \n must either rebuild the WorkSpaces or delete and recreate them.

    \n     " + } + }, + "com.amazonaws.workspaces#UpdateWorkspaceBundleRequest": { + "type": "structure", + "members": { + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", + "traits": { + "smithy.api#documentation": "

    The identifier of the bundle.

    " + } + }, + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the image.

    " + } + } + } + }, + "com.amazonaws.workspaces#UpdateWorkspaceBundleResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#UpdateWorkspaceImagePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#UpdateWorkspaceImagePermissionRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#UpdateWorkspaceImagePermissionResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspaces#ResourceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

    Shares or unshares an image with one account in the same Amazon Web Services Region by\n specifying whether that account has permission to copy the image. If the copy image\n permission is granted, the image is shared with that account. If the copy image permission\n is revoked, the image is unshared with the account.

    \n

    After an image has been shared, the recipient account can copy the image to other\n Regions as needed.

    \n

    In the China (Ningxia) Region, you can copy images only within the same Region.

    \n

    In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

    \n

    For more information about sharing images, see Share or Unshare a Custom\n WorkSpaces Image.

    \n \n
      \n
    • \n

      To delete an image that has been shared, you must unshare the image before you\n delete it.

      \n
      • \n
    • \n

      Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts\n isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images\n across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.

      \n
      • \n
    \n     " + } + }, + "com.amazonaws.workspaces#UpdateWorkspaceImagePermissionRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the image.

    ", + "smithy.api#required": {} + } + }, + "AllowCopyImage": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    The permission to copy the image. This permission can be revoked only after an image has\n been shared.

    ", + "smithy.api#required": {} + } + }, + "SharedAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", + "traits": { + "smithy.api#documentation": "

    The identifier of the Amazon Web Services account to share or unshare the image\n with.

    \n \n

    Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.

    \n     ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#UpdateWorkspaceImagePermissionResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workspaces#UserName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.workspaces#UserStorage": { + "type": "structure", + "members": { + "Capacity": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The size of the user volume.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the user volume for a WorkSpace bundle.

    " + } + }, + "com.amazonaws.workspaces#UserVolumeSizeGib": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.workspaces#VolumeEncryptionKey": { + "type": "string" + }, + "com.amazonaws.workspaces#Workspace": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " + } + }, + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The identifier of the Directory Service directory for the WorkSpace.

    " + } + }, + "UserName": { + "target": "com.amazonaws.workspaces#UserName", + "traits": { + "smithy.api#documentation": "

    The user for the WorkSpace.

    " + } + }, + "IpAddress": { + "target": "com.amazonaws.workspaces#IpAddress", + "traits": { + "smithy.api#documentation": "

    The IP address of the WorkSpace.

    " + } + }, + "State": { + "target": "com.amazonaws.workspaces#WorkspaceState", + "traits": { + "smithy.api#documentation": "

    The operational state of the WorkSpace.

    \n \n

    After a WorkSpace is terminated, the TERMINATED state is returned only\n briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely\n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using\n \n DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace\n has been successfully terminated.

    \n     " + } + }, + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", + "traits": { + "smithy.api#documentation": "

    The identifier of the bundle used to create the WorkSpace.

    " + } + }, + "SubnetId": { + "target": "com.amazonaws.workspaces#SubnetId", + "traits": { + "smithy.api#documentation": "

    The identifier of the subnet for the WorkSpace.

    " + } + }, + "ErrorMessage": { + "target": "com.amazonaws.workspaces#Description", + "traits": { + "smithy.api#documentation": "

    The text of the error message that is returned if the WorkSpace cannot be\n created.

    " + } + }, + "ErrorCode": { + "target": "com.amazonaws.workspaces#WorkspaceErrorCode", + "traits": { + "smithy.api#documentation": "

    The error code that is returned if the WorkSpace cannot be created.

    " + } + }, + "ComputerName": { + "target": "com.amazonaws.workspaces#ComputerName", + "traits": { + "smithy.api#documentation": "

    The name of the WorkSpace, as seen by the operating system. The format of this name\n varies. For more information, see Launch a\n WorkSpace.

    " + } + }, + "VolumeEncryptionKey": { + "target": "com.amazonaws.workspaces#VolumeEncryptionKey", + "traits": { + "smithy.api#documentation": "

    The symmetric KMS key used to encrypt data stored on your WorkSpace.\n Amazon WorkSpaces does not support asymmetric KMS keys.

    " + } + }, + "UserVolumeEncryptionEnabled": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether the data stored on the user volume is encrypted.

    " + } + }, + "RootVolumeEncryptionEnabled": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether the data stored on the root volume is encrypted.

    " + } + }, + "WorkspaceProperties": { + "target": "com.amazonaws.workspaces#WorkspaceProperties", + "traits": { + "smithy.api#documentation": "

    The properties of the WorkSpace.

    " + } + }, + "ModificationStates": { + "target": "com.amazonaws.workspaces#ModificationStateList", + "traits": { + "smithy.api#documentation": "

    The modification states of the WorkSpace.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a WorkSpace.

    " + } + }, + "com.amazonaws.workspaces#WorkspaceAccessProperties": { + "type": "structure", + "members": { + "DeviceTypeWindows": { + "target": "com.amazonaws.workspaces#AccessPropertyValue", + "traits": { + "smithy.api#documentation": "

    Indicates whether users can use Windows clients to access their WorkSpaces.

    " + } + }, + "DeviceTypeOsx": { + "target": "com.amazonaws.workspaces#AccessPropertyValue", + "traits": { + "smithy.api#documentation": "

    Indicates whether users can use macOS clients to access their WorkSpaces.

    " + } + }, + "DeviceTypeWeb": { + "target": "com.amazonaws.workspaces#AccessPropertyValue", + "traits": { + "smithy.api#documentation": "

    Indicates whether users can access their WorkSpaces through a web browser.

    " + } + }, + "DeviceTypeIos": { + "target": "com.amazonaws.workspaces#AccessPropertyValue", + "traits": { + "smithy.api#documentation": "

    Indicates whether users can use iOS devices to access their WorkSpaces.

    " + } + }, + "DeviceTypeAndroid": { + "target": "com.amazonaws.workspaces#AccessPropertyValue", + "traits": { + "smithy.api#documentation": "

    Indicates whether users can use Android and Android-compatible Chrome OS devices to\n access their WorkSpaces.

    " + } + }, + "DeviceTypeChromeOs": { + "target": "com.amazonaws.workspaces#AccessPropertyValue", + "traits": { + "smithy.api#documentation": "

    Indicates whether users can use Chromebooks to access their WorkSpaces.

    " + } + }, + "DeviceTypeZeroClient": { + "target": "com.amazonaws.workspaces#AccessPropertyValue", + "traits": { + "smithy.api#documentation": "

    Indicates whether users can use zero client devices to access their WorkSpaces.

    " + } + }, + "DeviceTypeLinux": { + "target": "com.amazonaws.workspaces#AccessPropertyValue", + "traits": { + "smithy.api#documentation": "

    Indicates whether users can use Linux clients to access their WorkSpaces.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The device types and operating systems that can be used to access a WorkSpace. For more\n information, see Amazon\n WorkSpaces Client Network Requirements.

    " + } + }, + "com.amazonaws.workspaces#WorkspaceBundle": { + "type": "structure", + "members": { + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", + "traits": { + "smithy.api#documentation": "

    The identifier of the bundle.

    " + } + }, + "Name": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the bundle.

    " + } + }, + "Owner": { + "target": "com.amazonaws.workspaces#BundleOwner", + "traits": { + "smithy.api#documentation": "

    The owner of the bundle. This is the account identifier of the owner, or\n AMAZON if the bundle is provided by Amazon Web Services.

    " + } + }, + "Description": { + "target": "com.amazonaws.workspaces#Description", + "traits": { + "smithy.api#documentation": "

    The description of the bundle.

    " + } + }, + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the image that was used to create the bundle.

    " + } + }, + "RootStorage": { + "target": "com.amazonaws.workspaces#RootStorage", + "traits": { + "smithy.api#documentation": "

    The size of the root volume.

    " + } + }, + "UserStorage": { + "target": "com.amazonaws.workspaces#UserStorage", + "traits": { + "smithy.api#documentation": "

    The size of the user volume.

    " + } + }, + "ComputeType": { + "target": "com.amazonaws.workspaces#ComputeType", + "traits": { + "smithy.api#documentation": "

    The compute type of the bundle. For more information, see \n Amazon WorkSpaces Bundles.

    " + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

    The last time that the bundle was updated.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time when the bundle was created.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a WorkSpace bundle.

    " + } + }, + "com.amazonaws.workspaces#WorkspaceBundleDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_./() -]+$" + } + }, + "com.amazonaws.workspaces#WorkspaceBundleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_./()\\\\-]+$" + } + }, + "com.amazonaws.workspaces#WorkspaceConnectionStatus": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " + } + }, + "ConnectionState": { + "target": "com.amazonaws.workspaces#ConnectionState", + "traits": { + "smithy.api#documentation": "

    The connection state of the WorkSpace. The connection state is unknown if the WorkSpace\n is stopped.

    " + } + }, + "ConnectionStateCheckTimestamp": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

    The timestamp of the connection status check.

    " + } + }, + "LastKnownUserConnectionTimestamp": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

    The timestamp of the last known user connection.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the connection status of a WorkSpace.

    " + } + }, + "com.amazonaws.workspaces#WorkspaceConnectionStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspaceConnectionStatus" + } + }, + "com.amazonaws.workspaces#WorkspaceCreationProperties": { + "type": "structure", + "members": { + "EnableWorkDocs": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

    \n \n

    If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new\n WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs\n remains enabled for any existing WorkSpaces, unless you either disable users' access to\n WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see\n Disabling Users in the Amazon WorkDocs Administration\n Guide. To delete a WorkDocs site, see Deleting a Site in the\n Amazon WorkDocs Administration Guide.

    \n

    If you enable WorkDocs on a directory that already has existing WorkSpaces, the\n existing WorkSpaces and any new WorkSpaces that are launched in the directory will have\n WorkDocs enabled.

    \n     " + } + }, + "EnableInternetAccess": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether internet access is enabled for your WorkSpaces.

    " + } + }, + "DefaultOu": { + "target": "com.amazonaws.workspaces#DefaultOu", + "traits": { + "smithy.api#documentation": "

    The default organizational unit (OU) for your WorkSpaces directories. This string must\n be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target\n domain and OU. It must be in the form\n \"OU=value,DC=value,DC=value\",\n where value is any string of characters, and the number of domain\n components (DCs) is two or more. For example,\n OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

    \n \n
      \n
    • \n

      To avoid errors, certain characters in the distinguished name must be escaped.\n For more information, see Distinguished Names in the Microsoft documentation.

      \n
      • \n
    • \n

      The API doesn't validate whether the OU exists.

      \n
      • \n
    \n     " + } + }, + "CustomSecurityGroupId": { + "target": "com.amazonaws.workspaces#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

    The identifier of your custom security group.

    " + } + }, + "UserEnabledAsLocalAdministrator": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether users are local administrators of their WorkSpaces.

    " + } + }, + "EnableMaintenanceMode": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether maintenance mode is enabled for your WorkSpaces. For more information,\n see WorkSpace\n Maintenance.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the default properties that are used for creating WorkSpaces. For more\n information, see Update Directory\n Details for Your WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#WorkspaceDirectory": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The directory identifier.

    " + } + }, + "Alias": { + "target": "com.amazonaws.workspaces#Alias", + "traits": { + "smithy.api#documentation": "

    The directory alias.

    " + } + }, + "DirectoryName": { + "target": "com.amazonaws.workspaces#DirectoryName", + "traits": { + "smithy.api#documentation": "

    The name of the directory.

    " + } + }, + "RegistrationCode": { + "target": "com.amazonaws.workspaces#RegistrationCode", + "traits": { + "smithy.api#documentation": "

    The registration code for the directory. This is the code that users enter in their\n Amazon WorkSpaces client application to connect to the directory.

    " + } + }, + "SubnetIds": { + "target": "com.amazonaws.workspaces#SubnetIds", + "traits": { + "smithy.api#documentation": "

    The identifiers of the subnets used with the directory.

    " + } + }, + "DnsIpAddresses": { + "target": "com.amazonaws.workspaces#DnsIpAddresses", + "traits": { + "smithy.api#documentation": "

    The IP addresses of the DNS servers for the directory.

    " + } + }, + "CustomerUserName": { + "target": "com.amazonaws.workspaces#UserName", + "traits": { + "smithy.api#documentation": "

    The user name for the service account.

    " + } + }, + "IamRoleId": { + "target": "com.amazonaws.workspaces#ARN", + "traits": { + "smithy.api#documentation": "

    The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make\n calls to other services, such as Amazon EC2, on your behalf.

    " + } + }, + "DirectoryType": { + "target": "com.amazonaws.workspaces#WorkspaceDirectoryType", + "traits": { + "smithy.api#documentation": "

    The directory type.

    " + } + }, + "WorkspaceSecurityGroupId": { + "target": "com.amazonaws.workspaces#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

    The identifier of the security group that is assigned to new WorkSpaces.

    " + } + }, + "State": { + "target": "com.amazonaws.workspaces#WorkspaceDirectoryState", + "traits": { + "smithy.api#documentation": "

    The state of the directory's registration with Amazon WorkSpaces. After a directory is\n deregistered, the DEREGISTERED state is returned very briefly before the\n directory metadata is cleaned up, so this state is rarely returned. To confirm that a\n directory is deregistered, check for the directory ID by using \n DescribeWorkspaceDirectories. If the directory ID isn't returned, then the\n directory has been successfully deregistered.

    " + } + }, + "WorkspaceCreationProperties": { + "target": "com.amazonaws.workspaces#DefaultWorkspaceCreationProperties", + "traits": { + "smithy.api#documentation": "

    The default creation properties for all WorkSpaces in the directory.

    " + } + }, + "ipGroupIds": { + "target": "com.amazonaws.workspaces#IpGroupIdList", + "traits": { + "smithy.api#documentation": "

    The identifiers of the IP access control groups associated with the directory.

    " + } + }, + "WorkspaceAccessProperties": { + "target": "com.amazonaws.workspaces#WorkspaceAccessProperties", + "traits": { + "smithy.api#documentation": "

    The devices and operating systems that users can use to access WorkSpaces.

    " + } + }, + "Tenancy": { + "target": "com.amazonaws.workspaces#Tenancy", + "traits": { + "smithy.api#documentation": "

    Specifies whether the directory is dedicated or shared. To use Bring Your Own License\n (BYOL), this value must be set to DEDICATED. For more information, see Bring\n Your Own Windows Desktop Images.

    " + } + }, + "SelfservicePermissions": { + "target": "com.amazonaws.workspaces#SelfservicePermissions", + "traits": { + "smithy.api#documentation": "

    The default self-service permissions for WorkSpaces in the directory.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a directory that is used with Amazon WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#WorkspaceDirectoryState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "REGISTERING", + "name": "REGISTERING" + }, + { + "value": "REGISTERED", + "name": "REGISTERED" + }, + { + "value": "DEREGISTERING", + "name": "DEREGISTERING" + }, + { + "value": "DEREGISTERED", + "name": "DEREGISTERED" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.workspaces#WorkspaceDirectoryType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SIMPLE_AD", + "name": "SIMPLE_AD" + }, + { + "value": "AD_CONNECTOR", + "name": "AD_CONNECTOR" + } + ] + } + }, + "com.amazonaws.workspaces#WorkspaceErrorCode": { + "type": "string" + }, + "com.amazonaws.workspaces#WorkspaceId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^ws-[0-9a-z]{8,63}$" + } + }, + "com.amazonaws.workspaces#WorkspaceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspaceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#WorkspaceImage": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the image.

    " + } + }, + "Name": { + "target": "com.amazonaws.workspaces#WorkspaceImageName", + "traits": { + "smithy.api#documentation": "

    The name of the image.

    " + } + }, + "Description": { + "target": "com.amazonaws.workspaces#WorkspaceImageDescription", + "traits": { + "smithy.api#documentation": "

    The description of the image.

    " + } + }, + "OperatingSystem": { + "target": "com.amazonaws.workspaces#OperatingSystem", + "traits": { + "smithy.api#documentation": "

    The operating system that the image is running.

    " + } + }, + "State": { + "target": "com.amazonaws.workspaces#WorkspaceImageState", + "traits": { + "smithy.api#documentation": "

    The status of the image.

    " + } + }, + "RequiredTenancy": { + "target": "com.amazonaws.workspaces#WorkspaceImageRequiredTenancy", + "traits": { + "smithy.api#documentation": "

    Specifies whether the image is running on dedicated hardware. When Bring Your Own\n License (BYOL) is enabled, this value is set to DEDICATED. For more\n information, see Bring Your Own Windows\n Desktop Images.

    " + } + }, + "ErrorCode": { + "target": "com.amazonaws.workspaces#WorkspaceImageErrorCode", + "traits": { + "smithy.api#documentation": "

    The error code that is returned for the image.

    " + } + }, + "ErrorMessage": { + "target": "com.amazonaws.workspaces#Description", + "traits": { + "smithy.api#documentation": "

    The text of the error message that is returned for the image.

    " + } + }, + "Created": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date\n of the image.

    " + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", + "traits": { + "smithy.api#documentation": "

    The identifier of the Amazon Web Services account that owns the image.

    " + } + }, + "Updates": { + "target": "com.amazonaws.workspaces#UpdateResult", + "traits": { + "smithy.api#documentation": "

    The updates (if any) that are available for the specified image.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a WorkSpace image.

    " + } + }, + "com.amazonaws.workspaces#WorkspaceImageDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_./() -]+$" + } + }, + "com.amazonaws.workspaces#WorkspaceImageErrorCode": { + "type": "string" + }, + "com.amazonaws.workspaces#WorkspaceImageId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^wsi-[0-9a-z]{9,63}$" + } + }, + "com.amazonaws.workspaces#WorkspaceImageIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspaceImageId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#WorkspaceImageIngestionProcess": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BYOL_REGULAR", + "name": "BYOL_REGULAR" + }, + { + "value": "BYOL_GRAPHICS", + "name": "BYOL_GRAPHICS" + }, + { + "value": "BYOL_GRAPHICSPRO", + "name": "BYOL_GRAPHICSPRO" + }, + { + "value": "BYOL_REGULAR_WSP", + "name": "BYOL_REGULAR_WSP" + } + ] + } + }, + "com.amazonaws.workspaces#WorkspaceImageList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspaceImage" + } + }, + "com.amazonaws.workspaces#WorkspaceImageName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_./()\\\\-]+$" + } + }, + "com.amazonaws.workspaces#WorkspaceImageRequiredTenancy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DEFAULT", + "name": "DEFAULT" + }, + { + "value": "DEDICATED", + "name": "DEDICATED" + } + ] + } + }, + "com.amazonaws.workspaces#WorkspaceImageState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.workspaces#WorkspaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#Workspace" + } + }, + "com.amazonaws.workspaces#WorkspaceProperties": { + "type": "structure", + "members": { + "RunningMode": { + "target": "com.amazonaws.workspaces#RunningMode", + "traits": { + "smithy.api#documentation": "

    The running mode. For more information, see Manage the WorkSpace Running\n Mode.

    " + } + }, + "RunningModeAutoStopTimeoutInMinutes": { + "target": "com.amazonaws.workspaces#RunningModeAutoStopTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "

    The time after a user logs off when WorkSpaces are automatically stopped. Configured in\n 60-minute intervals.

    " + } + }, + "RootVolumeSizeGib": { + "target": "com.amazonaws.workspaces#RootVolumeSizeGib", + "traits": { + "smithy.api#documentation": "

    The size of the root volume. For important information about how to modify the size of\n the root and user volumes, see Modify a\n WorkSpace.

    " + } + }, + "UserVolumeSizeGib": { + "target": "com.amazonaws.workspaces#UserVolumeSizeGib", + "traits": { + "smithy.api#documentation": "

    The size of the user storage. For important information about how to modify the size of\n the root and user volumes, see Modify a\n WorkSpace.

    " + } + }, + "ComputeTypeName": { + "target": "com.amazonaws.workspaces#Compute", + "traits": { + "smithy.api#documentation": "

    The compute type. For more information, see Amazon WorkSpaces\n Bundles.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a WorkSpace.

    " + } + }, + "com.amazonaws.workspaces#WorkspaceRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

    The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

    ", + "smithy.api#required": {} + } + }, + "UserName": { + "target": "com.amazonaws.workspaces#UserName", + "traits": { + "smithy.api#documentation": "

    The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.

    ", + "smithy.api#required": {} + } + }, + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", + "traits": { + "smithy.api#documentation": "

    The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

    ", + "smithy.api#required": {} + } + }, + "VolumeEncryptionKey": { + "target": "com.amazonaws.workspaces#VolumeEncryptionKey", + "traits": { + "smithy.api#documentation": "

    The symmetric KMS key used to encrypt data stored on your WorkSpace.\n Amazon WorkSpaces does not support asymmetric KMS keys.

    " + } + }, + "UserVolumeEncryptionEnabled": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether the data stored on the user volume is encrypted.

    " + } + }, + "RootVolumeEncryptionEnabled": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether the data stored on the root volume is encrypted.

    " + } + }, + "WorkspaceProperties": { + "target": "com.amazonaws.workspaces#WorkspaceProperties", + "traits": { + "smithy.api#documentation": "

    The WorkSpace properties.

    " + } + }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

    The tags for the WorkSpace.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the information used to create a WorkSpace.

    " + } + }, + "com.amazonaws.workspaces#WorkspaceRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspaceRequest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#WorkspaceState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "IMPAIRED", + "name": "IMPAIRED" + }, + { + "value": "UNHEALTHY", + "name": "UNHEALTHY" + }, + { + "value": "REBOOTING", + "name": "REBOOTING" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "REBUILDING", + "name": "REBUILDING" + }, + { + "value": "RESTORING", + "name": "RESTORING" + }, + { + "value": "MAINTENANCE", + "name": "MAINTENANCE" + }, + { + "value": "ADMIN_MAINTENANCE", + "name": "ADMIN_MAINTENANCE" + }, + { + "value": "TERMINATING", + "name": "TERMINATING" + }, + { + "value": "TERMINATED", + "name": "TERMINATED" + }, + { + "value": "SUSPENDED", + "name": "SUSPENDED" + }, + { + "value": "UPDATING", + "name": "UPDATING" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.workspaces#WorkspacesDefaultRoleNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you\n will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#WorkspacesIpGroup": { + "type": "structure", + "members": { + "groupId": { + "target": "com.amazonaws.workspaces#IpGroupId", + "traits": { + "smithy.api#documentation": "

    The identifier of the group.

    " + } + }, + "groupName": { + "target": "com.amazonaws.workspaces#IpGroupName", + "traits": { + "smithy.api#documentation": "

    The name of the group.

    " + } + }, + "groupDesc": { + "target": "com.amazonaws.workspaces#IpGroupDesc", + "traits": { + "smithy.api#documentation": "

    The description of the group.

    " + } + }, + "userRules": { + "target": "com.amazonaws.workspaces#IpRuleList", + "traits": { + "smithy.api#documentation": "

    The rules.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes an IP access control group.

    " + } + }, + "com.amazonaws.workspaces#WorkspacesIpGroupsList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspacesIpGroup" + } + }, + "com.amazonaws.workspaces#WorkspacesService": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "WorkSpaces", + "arnNamespace": "workspaces", + "cloudFormationName": "WorkSpaces", + "cloudTrailEventSource": "workspaces.amazonaws.com", + "endpointPrefix": "workspaces" + }, + "aws.auth#sigv4": { + "name": "workspaces" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon WorkSpaces Service\n

    Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows\n or Amazon Linux desktops for your users, known as WorkSpaces.\n WorkSpaces eliminates the need to procure and deploy hardware or install complex\n software. You can quickly add or remove users as your needs change. Users can access their\n virtual desktops from multiple devices or web browsers.

    \n

    This API Reference provides detailed information about the actions, data types,\n parameters, and errors of the WorkSpaces service. For more information about the\n supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services\n General Reference.

    \n

    You can also manage your WorkSpaces resources using the WorkSpaces\n console, Command Line Interface (CLI), and SDKs. For more information about\n administering WorkSpaces, see the Amazon WorkSpaces Administration Guide.\n For more information about using the Amazon WorkSpaces client application or web\n browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more\n information about using the CLI to manage your WorkSpaces resources,\n see the WorkSpaces section of the CLI Reference.

    ", + "smithy.api#title": "Amazon WorkSpaces", + "smithy.api#xmlNamespace": { + "uri": "http://workspaces.amazonaws.com/api/v1" + } + }, + "version": "2015-04-08", + "operations": [ + { + "target": "com.amazonaws.workspaces#AssociateConnectionAlias" + }, + { + "target": "com.amazonaws.workspaces#AssociateIpGroups" + }, + { + "target": "com.amazonaws.workspaces#AuthorizeIpRules" + }, + { + "target": "com.amazonaws.workspaces#CopyWorkspaceImage" + }, + { + "target": "com.amazonaws.workspaces#CreateConnectClientAddIn" + }, + { + "target": "com.amazonaws.workspaces#CreateConnectionAlias" + }, + { + "target": "com.amazonaws.workspaces#CreateIpGroup" + }, + { + "target": "com.amazonaws.workspaces#CreateTags" + }, + { + "target": "com.amazonaws.workspaces#CreateUpdatedWorkspaceImage" + }, + { + "target": "com.amazonaws.workspaces#CreateWorkspaceBundle" + }, + { + "target": "com.amazonaws.workspaces#CreateWorkspaces" + }, + { + "target": "com.amazonaws.workspaces#DeleteClientBranding" + }, + { + "target": "com.amazonaws.workspaces#DeleteConnectClientAddIn" + }, + { + "target": "com.amazonaws.workspaces#DeleteConnectionAlias" + }, + { + "target": "com.amazonaws.workspaces#DeleteIpGroup" + }, + { + "target": "com.amazonaws.workspaces#DeleteTags" + }, + { + "target": "com.amazonaws.workspaces#DeleteWorkspaceBundle" + }, + { + "target": "com.amazonaws.workspaces#DeleteWorkspaceImage" + }, + { + "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectory" + }, + { + "target": "com.amazonaws.workspaces#DescribeAccount" + }, + { + "target": "com.amazonaws.workspaces#DescribeAccountModifications" + }, + { + "target": "com.amazonaws.workspaces#DescribeClientBranding" + }, + { + "target": "com.amazonaws.workspaces#DescribeClientProperties" + }, + { + "target": "com.amazonaws.workspaces#DescribeConnectClientAddIns" + }, + { + "target": "com.amazonaws.workspaces#DescribeConnectionAliases" + }, + { + "target": "com.amazonaws.workspaces#DescribeConnectionAliasPermissions" + }, + { + "target": "com.amazonaws.workspaces#DescribeIpGroups" + }, + { + "target": "com.amazonaws.workspaces#DescribeTags" + }, + { + "target": "com.amazonaws.workspaces#DescribeWorkspaceBundles" + }, + { + "target": "com.amazonaws.workspaces#DescribeWorkspaceDirectories" + }, + { + "target": "com.amazonaws.workspaces#DescribeWorkspaceImagePermissions" + }, + { + "target": "com.amazonaws.workspaces#DescribeWorkspaceImages" + }, + { + "target": "com.amazonaws.workspaces#DescribeWorkspaces" + }, + { + "target": "com.amazonaws.workspaces#DescribeWorkspacesConnectionStatus" + }, + { + "target": "com.amazonaws.workspaces#DescribeWorkspaceSnapshots" + }, + { + "target": "com.amazonaws.workspaces#DisassociateConnectionAlias" + }, + { + "target": "com.amazonaws.workspaces#DisassociateIpGroups" + }, + { + "target": "com.amazonaws.workspaces#ImportClientBranding" + }, + { + "target": "com.amazonaws.workspaces#ImportWorkspaceImage" + }, + { + "target": "com.amazonaws.workspaces#ListAvailableManagementCidrRanges" + }, + { + "target": "com.amazonaws.workspaces#MigrateWorkspace" + }, + { + "target": "com.amazonaws.workspaces#ModifyAccount" + }, + { + "target": "com.amazonaws.workspaces#ModifyClientProperties" + }, + { + "target": "com.amazonaws.workspaces#ModifySelfservicePermissions" + }, + { + "target": "com.amazonaws.workspaces#ModifyWorkspaceAccessProperties" + }, + { + "target": "com.amazonaws.workspaces#ModifyWorkspaceCreationProperties" + }, + { + "target": "com.amazonaws.workspaces#ModifyWorkspaceProperties" + }, + { + "target": "com.amazonaws.workspaces#ModifyWorkspaceState" + }, + { + "target": "com.amazonaws.workspaces#RebootWorkspaces" + }, + { + "target": "com.amazonaws.workspaces#RebuildWorkspaces" + }, + { + "target": "com.amazonaws.workspaces#RegisterWorkspaceDirectory" + }, + { + "target": "com.amazonaws.workspaces#RestoreWorkspace" + }, + { + "target": "com.amazonaws.workspaces#RevokeIpRules" + }, + { + "target": "com.amazonaws.workspaces#StartWorkspaces" + }, + { + "target": "com.amazonaws.workspaces#StopWorkspaces" + }, + { + "target": "com.amazonaws.workspaces#TerminateWorkspaces" + }, + { + "target": "com.amazonaws.workspaces#UpdateConnectClientAddIn" + }, + { + "target": "com.amazonaws.workspaces#UpdateConnectionAliasPermission" + }, + { + "target": "com.amazonaws.workspaces#UpdateRulesOfIpGroup" + }, + { + "target": "com.amazonaws.workspaces#UpdateWorkspaceBundle" + }, + { + "target": "com.amazonaws.workspaces#UpdateWorkspaceImagePermission" + } + ] } - ] } - } }