Skip to content

Commit

Permalink
feat(client-workspaces): A new field "ErrorDetails" will be added to …
Browse files Browse the repository at this point in the history 
…the output of "DescribeWorkspaceImages" API call. This field provides in-depth details about the error occurred during image import process. These details include the possible causes of the errors and troubleshooting information.
  • Loading branch information
awstools committed Sep 8, 2023
1 parent ee36843 commit ddc2901
Show file tree
Hide file tree
Showing 4 changed files with 269 additions and 1 deletion.
6 changes: 6 additions & 0 deletions clients/client-workspaces/src/commands/DescribeWorkspaceImagesCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,12 @@ export interface DescribeWorkspaceImagesCommandOutput extends DescribeWorkspaceI
* // UpdateAvailable: true || false,
* // Description: "STRING_VALUE",
* // },
* // ErrorDetails: [ // ErrorDetailsList
* // { // ErrorDetails
* // ErrorCode: "OutdatedPowershellVersion" || "OfficeInstalled" || "PCoIPAgentInstalled" || "WindowsUpdatesEnabled" || "AutoMountDisabled" || "WorkspacesBYOLAccountNotFound" || "WorkspacesBYOLAccountDisabled" || "DHCPDisabled" || "DiskFreeSpace" || "AdditionalDrivesAttached" || "OSNotSupported" || "DomainJoined" || "AzureDomainJoined" || "FirewallEnabled" || "VMWareToolsInstalled" || "DiskSizeExceeded" || "IncompatiblePartitioning" || "PendingReboot" || "AutoLogonEnabled" || "RealTimeUniversalDisabled" || "MultipleBootPartition" || "Requires64BitOS" || "ZeroRearmCount" || "InPlaceUpgrade" || "AntiVirusInstalled" || "UEFINotSupported",
* // ErrorMessage: "STRING_VALUE",
* // },
* // ],
* // },
* // ],
* // NextToken: "STRING_VALUE",
Expand Down
64 changes: 64 additions & 0 deletions clients/client-workspaces/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3268,6 +3268,64 @@ export interface DescribeWorkspaceImagesRequest {
MaxResults?: number;
}

/**
* @public
* @enum
*/
export const WorkspaceImageErrorDetailCode = {
ADDITIONAL_DRIVES_ATTACHED: "AdditionalDrivesAttached",
ANTI_VIRUS_INSTALLED: "AntiVirusInstalled",
AUTO_LOGON_ENABLED: "AutoLogonEnabled",
AUTO_MOUNT_DISABLED: "AutoMountDisabled",
AZURE_DOMAIN_JOINED: "AzureDomainJoined",
DHCP_DISABLED: "DHCPDisabled",
DISK_FREE_SPACE: "DiskFreeSpace",
DISK_SIZE_EXCEEDED: "DiskSizeExceeded",
DOMAIN_JOINED: "DomainJoined",
FIREWALL_ENABLED: "FirewallEnabled",
INCOMPATIBLE_PARTITIONING: "IncompatiblePartitioning",
IN_PLACE_UPGRADE: "InPlaceUpgrade",
MULTIPLE_BOOT_PARTITION: "MultipleBootPartition",
OFFICE_INSTALLED: "OfficeInstalled",
OS_NOT_SUPPORTED: "OSNotSupported",
OUTDATED_POWERSHELL_VERSION: "OutdatedPowershellVersion",
PCOIP_AGENT_INSTALLED: "PCoIPAgentInstalled",
PENDING_REBOOT: "PendingReboot",
REALTIME_UNIVERSAL_DISABLED: "RealTimeUniversalDisabled",
SIXTY_FOUR_BIT_OS: "Requires64BitOS",
UEFI_NOT_SUPPORTED: "UEFINotSupported",
VMWARE_TOOLS_INSTALLED: "VMWareToolsInstalled",
WINDOWS_UPDATES_ENABLED: "WindowsUpdatesEnabled",
WORKSPACES_BYOL_ACCOUNT_DISABLED: "WorkspacesBYOLAccountDisabled",
WORKSPACES_BYOL_ACCOUNT_NOT_FOUND: "WorkspacesBYOLAccountNotFound",
ZERO_REARM_COUNT: "ZeroRearmCount",
} as const;

/**
* @public
*/
export type WorkspaceImageErrorDetailCode =
(typeof WorkspaceImageErrorDetailCode)[keyof typeof WorkspaceImageErrorDetailCode];

/**
* @public
* <p>Provides in-depth details about the error. These details include the
* possible causes of the errors and troubleshooting information.</p>
*/
export interface ErrorDetails {
/**
* @public
* <p>Indicates the error code returned.</p>
*/
ErrorCode?: WorkspaceImageErrorDetailCode | string;

/**
* @public
* <p>The text of the error message related the error code.</p>
*/
ErrorMessage?: string;
}

/**
* @public
* <p>Describes whether a WorkSpace image needs to be updated with the latest drivers and
Expand Down Expand Up @@ -3366,6 +3424,12 @@ export interface WorkspaceImage {
* <p>The updates (if any) that are available for the specified image.</p>
*/
Updates?: UpdateResult;

/**
* @public
* <p>The details of the error returned for the image.</p>
*/
ErrorDetails?: ErrorDetails[];
}

/**
Expand Down
5 changes: 5 additions & 0 deletions clients/client-workspaces/src/protocols/Aws_json1_1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5403,6 +5403,10 @@ const de_DescribeWorkspaceSnapshotsResult = (

// de_DnsIpAddresses omitted.

// de_ErrorDetails omitted.

// de_ErrorDetailsList omitted.

// de_FailedCreateStandbyWorkspacesRequest omitted.

// de_FailedCreateStandbyWorkspacesRequestList omitted.
Expand Down Expand Up @@ -5626,6 +5630,7 @@ const de_WorkspaceImage = (output: any, context: __SerdeContext): WorkspaceImage
Created: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
Description: __expectString,
ErrorCode: __expectString,
ErrorDetails: _json,
ErrorMessage: __expectString,
ImageId: __expectString,
Name: __expectString,
Expand Down
195 changes: 194 additions & 1 deletion codegen/sdk-codegen/aws-models/workspaces.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3589,6 +3589,32 @@
"smithy.api#pattern": "^ami\\-([a-f0-9]{8}|[a-f0-9]{17})$"
}
},
"com.amazonaws.workspaces#ErrorDetails": {
"type": "structure",
"members": {
"ErrorCode": {
"target": "com.amazonaws.workspaces#WorkspaceImageErrorDetailCode",
"traits": {
"smithy.api#documentation": "<p>Indicates the error code returned.</p>"
}
},
"ErrorMessage": {
"target": "com.amazonaws.workspaces#Description",
"traits": {
"smithy.api#documentation": "<p>The text of the error message related the error code.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides in-depth details about the error. These details include the \n possible causes of the errors and troubleshooting information.</p>"
}
},
"com.amazonaws.workspaces#ErrorDetailsList": {
"type": "list",
"member": {
"target": "com.amazonaws.workspaces#ErrorDetails"
}
},
"com.amazonaws.workspaces#ErrorType": {
"type": "string"
},
Expand Down Expand Up @@ -7155,6 +7181,12 @@
"traits": {
"smithy.api#documentation": "<p>The updates (if any) that are available for the specified image.</p>"
}
},
"ErrorDetails": {
"target": "com.amazonaws.workspaces#ErrorDetailsList",
"traits": {
"smithy.api#documentation": "<p>The details of the error returned for the image.</p>"
}
}
},
"traits": {
Expand All @@ -7174,6 +7206,167 @@
"com.amazonaws.workspaces#WorkspaceImageErrorCode": {
"type": "string"
},
"com.amazonaws.workspaces#WorkspaceImageErrorDetailCode": {
"type": "enum",
"members": {
"OUTDATED_POWERSHELL_VERSION": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "OutdatedPowershellVersion"
}
},
"OFFICE_INSTALLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "OfficeInstalled"
}
},
"PCOIP_AGENT_INSTALLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "PCoIPAgentInstalled"
}
},
"WINDOWS_UPDATES_ENABLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "WindowsUpdatesEnabled"
}
},
"AUTO_MOUNT_DISABLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AutoMountDisabled"
}
},
"WORKSPACES_BYOL_ACCOUNT_NOT_FOUND": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "WorkspacesBYOLAccountNotFound"
}
},
"WORKSPACES_BYOL_ACCOUNT_DISABLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "WorkspacesBYOLAccountDisabled"
}
},
"DHCP_DISABLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DHCPDisabled"
}
},
"DISK_FREE_SPACE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DiskFreeSpace"
}
},
"ADDITIONAL_DRIVES_ATTACHED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AdditionalDrivesAttached"
}
},
"OS_NOT_SUPPORTED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "OSNotSupported"
}
},
"DOMAIN_JOINED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DomainJoined"
}
},
"AZURE_DOMAIN_JOINED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AzureDomainJoined"
}
},
"FIREWALL_ENABLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "FirewallEnabled"
}
},
"VMWARE_TOOLS_INSTALLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "VMWareToolsInstalled"
}
},
"DISK_SIZE_EXCEEDED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DiskSizeExceeded"
}
},
"INCOMPATIBLE_PARTITIONING": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "IncompatiblePartitioning"
}
},
"PENDING_REBOOT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "PendingReboot"
}
},
"AUTO_LOGON_ENABLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AutoLogonEnabled"
}
},
"REALTIME_UNIVERSAL_DISABLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "RealTimeUniversalDisabled"
}
},
"MULTIPLE_BOOT_PARTITION": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "MultipleBootPartition"
}
},
"SIXTY_FOUR_BIT_OS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "Requires64BitOS"
}
},
"ZERO_REARM_COUNT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ZeroRearmCount"
}
},
"IN_PLACE_UPGRADE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "InPlaceUpgrade"
}
},
"ANTI_VIRUS_INSTALLED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AntiVirusInstalled"
}
},
"UEFI_NOT_SUPPORTED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "UEFINotSupported"
}
}
}
},
"com.amazonaws.workspaces#WorkspaceImageId": {
"type": "string",
"traits": {
Expand Down Expand Up @@ -8616,4 +8809,4 @@
}
}
}
}
}

0 comments on commit ddc2901

Please sign in to comment.