feat(client-workspaces): Add StateMessage and ProgressPercentage fields to DescribeCustomWorkspaceImageImport API response.

awstools · awstools · commit fe652fb5ea11 · 2026-01-07T19:12:09.000Z
diff --git a/clients/client-workspaces/src/commands/AssociateWorkspaceApplicationCommand.ts b/clients/client-workspaces/src/commands/AssociateWorkspaceApplicationCommand.ts
@@ -50,7 +50,7 @@ export interface AssociateWorkspaceApplicationCommandOutput extends AssociateWor
  * //     LastUpdatedTime: new Date("TIMESTAMP"),
  * //     State: "PENDING_INSTALL" || "PENDING_INSTALL_DEPLOYMENT" || "PENDING_UNINSTALL" || "PENDING_UNINSTALL_DEPLOYMENT" || "INSTALLING" || "UNINSTALLING" || "ERROR" || "COMPLETED" || "REMOVED",
  * //     StateReason: { // AssociationStateReason
- * //       ErrorCode: "ValidationError.InsufficientDiskSpace" || "ValidationError.InsufficientMemory" || "ValidationError.UnsupportedOperatingSystem" || "DeploymentError.InternalServerError" || "DeploymentError.WorkspaceUnreachable",
+ * //       ErrorCode: "ValidationError.InsufficientDiskSpace" || "ValidationError.InsufficientMemory" || "ValidationError.UnsupportedOperatingSystem" || "DeploymentError.InternalServerError" || "DeploymentError.WorkspaceUnreachable" || "ValidationError.ApplicationOldVersionExists",
  * //       ErrorMessage: "STRING_VALUE",
  * //     },
  * //     WorkspaceId: "STRING_VALUE",
diff --git a/clients/client-workspaces/src/commands/CopyWorkspaceImageCommand.ts b/clients/client-workspaces/src/commands/CopyWorkspaceImageCommand.ts
@@ -31,7 +31,7 @@ export interface CopyWorkspaceImageCommandOutput extends CopyWorkspaceImageResul
  *          information about copying images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html"> Copy a Custom WorkSpaces
  *             Image</a>.</p>
  *          <p>In the China (Ningxia) Region, you can copy images only within the same Region.</p>
- *          <p>In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web ServicesSupport.</p>
+ *          <p>In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.</p>
  *          <important>
  *             <p>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
diff --git a/clients/client-workspaces/src/commands/DeployWorkspaceApplicationsCommand.ts b/clients/client-workspaces/src/commands/DeployWorkspaceApplicationsCommand.ts
@@ -52,7 +52,7 @@ export interface DeployWorkspaceApplicationsCommandOutput extends DeployWorkspac
  * //         LastUpdatedTime: new Date("TIMESTAMP"),
  * //         State: "PENDING_INSTALL" || "PENDING_INSTALL_DEPLOYMENT" || "PENDING_UNINSTALL" || "PENDING_UNINSTALL_DEPLOYMENT" || "INSTALLING" || "UNINSTALLING" || "ERROR" || "COMPLETED" || "REMOVED",
  * //         StateReason: { // AssociationStateReason
- * //           ErrorCode: "ValidationError.InsufficientDiskSpace" || "ValidationError.InsufficientMemory" || "ValidationError.UnsupportedOperatingSystem" || "DeploymentError.InternalServerError" || "DeploymentError.WorkspaceUnreachable",
+ * //           ErrorCode: "ValidationError.InsufficientDiskSpace" || "ValidationError.InsufficientMemory" || "ValidationError.UnsupportedOperatingSystem" || "DeploymentError.InternalServerError" || "DeploymentError.WorkspaceUnreachable" || "ValidationError.ApplicationOldVersionExists",
  * //           ErrorMessage: "STRING_VALUE",
  * //         },
  * //         WorkspaceId: "STRING_VALUE",
diff --git a/clients/client-workspaces/src/commands/DescribeApplicationAssociationsCommand.ts b/clients/client-workspaces/src/commands/DescribeApplicationAssociationsCommand.ts
@@ -56,7 +56,7 @@ export interface DescribeApplicationAssociationsCommandOutput extends DescribeAp
  * //       LastUpdatedTime: new Date("TIMESTAMP"),
  * //       State: "PENDING_INSTALL" || "PENDING_INSTALL_DEPLOYMENT" || "PENDING_UNINSTALL" || "PENDING_UNINSTALL_DEPLOYMENT" || "INSTALLING" || "UNINSTALLING" || "ERROR" || "COMPLETED" || "REMOVED",
  * //       StateReason: { // AssociationStateReason
- * //         ErrorCode: "ValidationError.InsufficientDiskSpace" || "ValidationError.InsufficientMemory" || "ValidationError.UnsupportedOperatingSystem" || "DeploymentError.InternalServerError" || "DeploymentError.WorkspaceUnreachable",
+ * //         ErrorCode: "ValidationError.InsufficientDiskSpace" || "ValidationError.InsufficientMemory" || "ValidationError.UnsupportedOperatingSystem" || "DeploymentError.InternalServerError" || "DeploymentError.WorkspaceUnreachable" || "ValidationError.ApplicationOldVersionExists",
  * //         ErrorMessage: "STRING_VALUE",
  * //       },
  * //     },
diff --git a/clients/client-workspaces/src/commands/DescribeBundleAssociationsCommand.ts b/clients/client-workspaces/src/commands/DescribeBundleAssociationsCommand.ts
@@ -54,7 +54,7 @@ export interface DescribeBundleAssociationsCommandOutput extends DescribeBundleA
  * //       LastUpdatedTime: new Date("TIMESTAMP"),
  * //       State: "PENDING_INSTALL" || "PENDING_INSTALL_DEPLOYMENT" || "PENDING_UNINSTALL" || "PENDING_UNINSTALL_DEPLOYMENT" || "INSTALLING" || "UNINSTALLING" || "ERROR" || "COMPLETED" || "REMOVED",
  * //       StateReason: { // AssociationStateReason
- * //         ErrorCode: "ValidationError.InsufficientDiskSpace" || "ValidationError.InsufficientMemory" || "ValidationError.UnsupportedOperatingSystem" || "DeploymentError.InternalServerError" || "DeploymentError.WorkspaceUnreachable",
+ * //         ErrorCode: "ValidationError.InsufficientDiskSpace" || "ValidationError.InsufficientMemory" || "ValidationError.UnsupportedOperatingSystem" || "DeploymentError.InternalServerError" || "DeploymentError.WorkspaceUnreachable" || "ValidationError.ApplicationOldVersionExists",
  * //         ErrorMessage: "STRING_VALUE",
  * //       },
  * //     },
diff --git a/clients/client-workspaces/src/commands/DescribeCustomWorkspaceImageImportCommand.ts b/clients/client-workspaces/src/commands/DescribeCustomWorkspaceImageImportCommand.ts
@@ -47,7 +47,9 @@ export interface DescribeCustomWorkspaceImageImportCommandOutput extends Describ
  * // { // DescribeCustomWorkspaceImageImportResult
  * //   ImageId: "STRING_VALUE",
  * //   InfrastructureConfigurationArn: "STRING_VALUE",
- * //   State: "PENDING" || "IN_PROGRESS" || "COMPLETED" || "ERROR",
+ * //   State: "PENDING" || "IN_PROGRESS" || "PROCESSING_SOURCE_IMAGE" || "IMAGE_TESTING_START" || "UPDATING_OPERATING_SYSTEM" || "IMAGE_COMPATIBILITY_CHECKING" || "IMAGE_TESTING_GENERALIZATION" || "CREATING_TEST_INSTANCE" || "INSTALLING_COMPONENTS" || "GENERALIZING" || "VALIDATING" || "PUBLISHING" || "COMPLETED" || "ERROR",
+ * //   StateMessage: "STRING_VALUE",
+ * //   ProgressPercentage: Number("int"),
  * //   Created: new Date("TIMESTAMP"),
  * //   LastUpdatedTime: new Date("TIMESTAMP"),
  * //   ImageSource: { // ImageSourceIdentifier Union: only one key present
diff --git a/clients/client-workspaces/src/commands/DescribeImageAssociationsCommand.ts b/clients/client-workspaces/src/commands/DescribeImageAssociationsCommand.ts
@@ -54,7 +54,7 @@ export interface DescribeImageAssociationsCommandOutput extends DescribeImageAss
  * //       ImageId: "STRING_VALUE",
  * //       State: "PENDING_INSTALL" || "PENDING_INSTALL_DEPLOYMENT" || "PENDING_UNINSTALL" || "PENDING_UNINSTALL_DEPLOYMENT" || "INSTALLING" || "UNINSTALLING" || "ERROR" || "COMPLETED" || "REMOVED",
  * //       StateReason: { // AssociationStateReason
- * //         ErrorCode: "ValidationError.InsufficientDiskSpace" || "ValidationError.InsufficientMemory" || "ValidationError.UnsupportedOperatingSystem" || "DeploymentError.InternalServerError" || "DeploymentError.WorkspaceUnreachable",
+ * //         ErrorCode: "ValidationError.InsufficientDiskSpace" || "ValidationError.InsufficientMemory" || "ValidationError.UnsupportedOperatingSystem" || "DeploymentError.InternalServerError" || "DeploymentError.WorkspaceUnreachable" || "ValidationError.ApplicationOldVersionExists",
  * //         ErrorMessage: "STRING_VALUE",
  * //       },
  * //     },
diff --git a/clients/client-workspaces/src/commands/DescribeWorkspaceAssociationsCommand.ts b/clients/client-workspaces/src/commands/DescribeWorkspaceAssociationsCommand.ts
@@ -53,7 +53,7 @@ export interface DescribeWorkspaceAssociationsCommandOutput extends DescribeWork
  * //       LastUpdatedTime: new Date("TIMESTAMP"),
  * //       State: "PENDING_INSTALL" || "PENDING_INSTALL_DEPLOYMENT" || "PENDING_UNINSTALL" || "PENDING_UNINSTALL_DEPLOYMENT" || "INSTALLING" || "UNINSTALLING" || "ERROR" || "COMPLETED" || "REMOVED",
  * //       StateReason: { // AssociationStateReason
- * //         ErrorCode: "ValidationError.InsufficientDiskSpace" || "ValidationError.InsufficientMemory" || "ValidationError.UnsupportedOperatingSystem" || "DeploymentError.InternalServerError" || "DeploymentError.WorkspaceUnreachable",
+ * //         ErrorCode: "ValidationError.InsufficientDiskSpace" || "ValidationError.InsufficientMemory" || "ValidationError.UnsupportedOperatingSystem" || "DeploymentError.InternalServerError" || "DeploymentError.WorkspaceUnreachable" || "ValidationError.ApplicationOldVersionExists",
  * //         ErrorMessage: "STRING_VALUE",
  * //       },
  * //       WorkspaceId: "STRING_VALUE",
diff --git a/clients/client-workspaces/src/commands/DisassociateWorkspaceApplicationCommand.ts b/clients/client-workspaces/src/commands/DisassociateWorkspaceApplicationCommand.ts
@@ -53,7 +53,7 @@ export interface DisassociateWorkspaceApplicationCommandOutput extends Disassoci
  * //     LastUpdatedTime: new Date("TIMESTAMP"),
  * //     State: "PENDING_INSTALL" || "PENDING_INSTALL_DEPLOYMENT" || "PENDING_UNINSTALL" || "PENDING_UNINSTALL_DEPLOYMENT" || "INSTALLING" || "UNINSTALLING" || "ERROR" || "COMPLETED" || "REMOVED",
  * //     StateReason: { // AssociationStateReason
- * //       ErrorCode: "ValidationError.InsufficientDiskSpace" || "ValidationError.InsufficientMemory" || "ValidationError.UnsupportedOperatingSystem" || "DeploymentError.InternalServerError" || "DeploymentError.WorkspaceUnreachable",
+ * //       ErrorCode: "ValidationError.InsufficientDiskSpace" || "ValidationError.InsufficientMemory" || "ValidationError.UnsupportedOperatingSystem" || "DeploymentError.InternalServerError" || "DeploymentError.WorkspaceUnreachable" || "ValidationError.ApplicationOldVersionExists",
  * //       ErrorMessage: "STRING_VALUE",
  * //     },
  * //     WorkspaceId: "STRING_VALUE",
diff --git a/clients/client-workspaces/src/commands/ImportCustomWorkspaceImageCommand.ts b/clients/client-workspaces/src/commands/ImportCustomWorkspaceImageCommand.ts
@@ -65,7 +65,7 @@ export interface ImportCustomWorkspaceImageCommandOutput extends ImportCustomWor
  * const response = await client.send(command);
  * // { // ImportCustomWorkspaceImageResult
  * //   ImageId: "STRING_VALUE",
- * //   State: "PENDING" || "IN_PROGRESS" || "COMPLETED" || "ERROR",
+ * //   State: "PENDING" || "IN_PROGRESS" || "PROCESSING_SOURCE_IMAGE" || "IMAGE_TESTING_START" || "UPDATING_OPERATING_SYSTEM" || "IMAGE_COMPATIBILITY_CHECKING" || "IMAGE_TESTING_GENERALIZATION" || "CREATING_TEST_INSTANCE" || "INSTALLING_COMPONENTS" || "GENERALIZING" || "VALIDATING" || "PUBLISHING" || "COMPLETED" || "ERROR",
  * // };
  *
  * ```
diff --git a/clients/client-workspaces/src/commands/TerminateWorkspacesCommand.ts b/clients/client-workspaces/src/commands/TerminateWorkspacesCommand.ts
@@ -30,7 +30,7 @@ export interface TerminateWorkspacesCommandOutput extends TerminateWorkspacesRes
  * <p>Terminates the specified WorkSpaces.</p>
  *          <important>
  *             <p>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 ServicesSupport before
+ *             is destroyed. If you need to archive any user data, contact Amazon Web Services Support before
  *             terminating the WorkSpace.</p>
  *          </important>
  *          <p>You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>.</p>
diff --git a/clients/client-workspaces/src/commands/UpdateWorkspaceImagePermissionCommand.ts b/clients/client-workspaces/src/commands/UpdateWorkspaceImagePermissionCommand.ts
@@ -34,7 +34,7 @@ export interface UpdateWorkspaceImagePermissionCommandOutput extends UpdateWorks
  *          <p>After an image has been shared, the recipient account can copy the image to other
  *          Regions as needed.</p>
  *          <p>In the China (Ningxia) Region, you can copy images only within the same Region.</p>
- *          <p>In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web ServicesSupport.</p>
+ *          <p>In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.</p>
  *          <p>For more information about sharing images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html"> Share or Unshare a Custom
  *             WorkSpaces Image</a>.</p>
  *          <note>
@@ -46,7 +46,7 @@ export interface UpdateWorkspaceImagePermissionCommandOutput extends UpdateWorks
  *                <li>
  *                   <p>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 ServicesSupport.</p>
+ *                   across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.</p>
  *                </li>
  *             </ul>
  *          </note>
diff --git a/clients/client-workspaces/src/models/enums.ts b/clients/client-workspaces/src/models/enums.ts
@@ -190,6 +190,7 @@ export type AssociationState = (typeof AssociationState)[keyof typeof Associatio
  * @enum
  */
 export const AssociationErrorCode = {
+  APPLICATION_OLDVERSIONEXIST_FAILURE: "ValidationError.ApplicationOldVersionExists",
   INSUFFICIENT_DISKSPACE: "ValidationError.InsufficientDiskSpace",
   INSUFFICIENT_MEMORY: "ValidationError.InsufficientMemory",
   INTERNAL_SERVER_ERROR: "DeploymentError.InternalServerError",
@@ -679,9 +680,19 @@ export type CustomImageProtocol = (typeof CustomImageProtocol)[keyof typeof Cust
  */
 export const CustomWorkspaceImageImportState = {
   COMPLETED: "COMPLETED",
+  CREATING_TEST_INSTANCE: "CREATING_TEST_INSTANCE",
   ERROR: "ERROR",
+  GENERALIZING: "GENERALIZING",
+  IMAGE_COMPATIBILITY_CHECKING: "IMAGE_COMPATIBILITY_CHECKING",
+  IMAGE_TESTING_GENERALIZATION: "IMAGE_TESTING_GENERALIZATION",
+  IMAGE_TESTING_START: "IMAGE_TESTING_START",
+  INSTALLING_COMPONENTS: "INSTALLING_COMPONENTS",
   IN_PROGRESS: "IN_PROGRESS",
   PENDING: "PENDING",
+  PROCESSING_SOURCE_IMAGE: "PROCESSING_SOURCE_IMAGE",
+  PUBLISHING: "PUBLISHING",
+  UPDATING_OPERATING_SYSTEM: "UPDATING_OPERATING_SYSTEM",
+  VALIDATING: "VALIDATING",
 } as const;
 /**
  * @public
diff --git a/clients/client-workspaces/src/models/models_0.ts b/clients/client-workspaces/src/models/models_0.ts
@@ -3324,6 +3324,18 @@ export interface DescribeCustomWorkspaceImageImportResult {
    */
   State?: CustomWorkspaceImageImportState | undefined;
 
+  /**
+   * <p>The state message of the WorkSpace image import workflow.</p>
+   * @public
+   */
+  StateMessage?: string | undefined;
+
+  /**
+   * <p>The estimated progress percentage of the WorkSpace image import workflow.</p>
+   * @public
+   */
+  ProgressPercentage?: number | undefined;
+
   /**
    * <p>The timestamp when the WorkSpace image import was created.</p>
    * @public
diff --git a/clients/client-workspaces/src/schemas/schemas_0.ts b/clients/client-workspaces/src/schemas/schemas_0.ts
@@ -459,7 +459,8 @@ const _PCSWRL = "PendingCreateStandbyWorkspacesRequestList";
 const _PI = "PoolId";
 const _PIo = "PoolIds";
 const _PN = "PoolName";
-const _PP = "PreferredProtocol";
+const _PP = "ProgressPercentage";
+const _PPr = "PreferredProtocol";
 const _PR = "PrimaryRegion";
 const _PRe = "PendingRequests";
 const _PSR = "PendingStandbyRequests";
@@ -536,6 +537,7 @@ const _SIe = "SessionId";
 const _SIu = "SubnetId";
 const _SL = "SupportLink";
 const _SLn = "SnapshotList";
+const _SM = "StateMessage";
 const _SOSN = "SupportedOperatingSystemNames";
 const _SP = "SamlProperties";
 const _SPe = "SelfservicePermissions";
@@ -1250,8 +1252,8 @@ export var DescribeCustomWorkspaceImageImportRequest$: StaticStructureSchema = [
 ];
 export var DescribeCustomWorkspaceImageImportResult$: StaticStructureSchema = [3, n0, _DCWIIRe,
   0,
-  [_II, _ICA, _S, _C, _LUT, _IS, _IBII, _ED],
-  [0, 0, 0, 4, 4, () => ImageSourceIdentifier$, 0, () => CustomWorkspaceImageImportErrorDetailsList]
+  [_II, _ICA, _S, _SM, _PP, _C, _LUT, _IS, _IBII, _ED],
+  [0, 0, 0, 0, 1, 4, 4, () => ImageSourceIdentifier$, 0, () => CustomWorkspaceImageImportErrorDetailsList]
 ];
 export var DescribeImageAssociationsRequest$: StaticStructureSchema = [3, n0, _DIAR,
   0,
@@ -1455,12 +1457,12 @@ export var GetAccountLinkResult$: StaticStructureSchema = [3, n0, _GALRe,
 ];
 export var GlobalAcceleratorForDirectory$: StaticStructureSchema = [3, n0, _GAFD,
   0,
-  [_Mo, _PP],
+  [_Mo, _PPr],
   [0, 0]
 ];
 export var GlobalAcceleratorForWorkSpace$: StaticStructureSchema = [3, n0, _GAFWS,
   0,
-  [_Mo, _PP],
+  [_Mo, _PPr],
   [0, 0]
 ];
 export var IDCConfig$: StaticStructureSchema = [3, n0, _IDCC,
diff --git a/codegen/sdk-codegen/aws-models/workspaces.json b/codegen/sdk-codegen/aws-models/workspaces.json

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ export interface ImportCustomWorkspaceImageCommandOutput extends ImportCustomWor`
`65`	`65`	`* const response = await client.send(command);`
`66`	`66`	`* // { // ImportCustomWorkspaceImageResult`
`67`	`67`	`* // ImageId: "STRING_VALUE",`
`68`		`- * // State: "PENDING" \|\| "IN_PROGRESS" \|\| "COMPLETED" \|\| "ERROR",`
	`68`	`+ * // State: "PENDING" \|\| "IN_PROGRESS" \|\| "PROCESSING_SOURCE_IMAGE" \|\| "IMAGE_TESTING_START" \|\| "UPDATING_OPERATING_SYSTEM" \|\| "IMAGE_COMPATIBILITY_CHECKING" \|\| "IMAGE_TESTING_GENERALIZATION" \|\| "CREATING_TEST_INSTANCE" \|\| "INSTALLING_COMPONENTS" \|\| "GENERALIZING" \|\| "VALIDATING" \|\| "PUBLISHING" \|\| "COMPLETED" \|\| "ERROR",`
`69`	`69`	`* // };`
`70`	`70`	`*`
`71`	`71`	* ```