Skip to content

Commit ddc2901

Browse files
author
awstools
committed
feat(client-workspaces): A new field "ErrorDetails" will be added to 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.
1 parent ee36843 commit ddc2901

File tree

4 files changed

+269
-1
lines changed

4 files changed

+269
-1
lines changed

‎clients/client-workspaces/src/commands/DescribeWorkspaceImagesCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,12 @@ export interface DescribeWorkspaceImagesCommandOutput extends DescribeWorkspaceI
7373
* // UpdateAvailable: true || false,
7474
* // Description: "STRING_VALUE",
7575
* // },
76+
* // ErrorDetails: [ // ErrorDetailsList
77+
* // { // ErrorDetails
78+
* // 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",
79+
* // ErrorMessage: "STRING_VALUE",
80+
* // },
81+
* // ],
7682
* // },
7783
* // ],
7884
* // NextToken: "STRING_VALUE",

‎clients/client-workspaces/src/models/models_0.ts

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3268,6 +3268,64 @@ export interface DescribeWorkspaceImagesRequest {
32683268
MaxResults?: number;
32693269
}
32703270

3271+
/**
3272+
* @public
3273+
* @enum
3274+
*/
3275+
export const WorkspaceImageErrorDetailCode = {
3276+
ADDITIONAL_DRIVES_ATTACHED: "AdditionalDrivesAttached",
3277+
ANTI_VIRUS_INSTALLED: "AntiVirusInstalled",
3278+
AUTO_LOGON_ENABLED: "AutoLogonEnabled",
3279+
AUTO_MOUNT_DISABLED: "AutoMountDisabled",
3280+
AZURE_DOMAIN_JOINED: "AzureDomainJoined",
3281+
DHCP_DISABLED: "DHCPDisabled",
3282+
DISK_FREE_SPACE: "DiskFreeSpace",
3283+
DISK_SIZE_EXCEEDED: "DiskSizeExceeded",
3284+
DOMAIN_JOINED: "DomainJoined",
3285+
FIREWALL_ENABLED: "FirewallEnabled",
3286+
INCOMPATIBLE_PARTITIONING: "IncompatiblePartitioning",
3287+
IN_PLACE_UPGRADE: "InPlaceUpgrade",
3288+
MULTIPLE_BOOT_PARTITION: "MultipleBootPartition",
3289+
OFFICE_INSTALLED: "OfficeInstalled",
3290+
OS_NOT_SUPPORTED: "OSNotSupported",
3291+
OUTDATED_POWERSHELL_VERSION: "OutdatedPowershellVersion",
3292+
PCOIP_AGENT_INSTALLED: "PCoIPAgentInstalled",
3293+
PENDING_REBOOT: "PendingReboot",
3294+
REALTIME_UNIVERSAL_DISABLED: "RealTimeUniversalDisabled",
3295+
SIXTY_FOUR_BIT_OS: "Requires64BitOS",
3296+
UEFI_NOT_SUPPORTED: "UEFINotSupported",
3297+
VMWARE_TOOLS_INSTALLED: "VMWareToolsInstalled",
3298+
WINDOWS_UPDATES_ENABLED: "WindowsUpdatesEnabled",
3299+
WORKSPACES_BYOL_ACCOUNT_DISABLED: "WorkspacesBYOLAccountDisabled",
3300+
WORKSPACES_BYOL_ACCOUNT_NOT_FOUND: "WorkspacesBYOLAccountNotFound",
3301+
ZERO_REARM_COUNT: "ZeroRearmCount",
3302+
} as const;
3303+
3304+
/**
3305+
* @public
3306+
*/
3307+
export type WorkspaceImageErrorDetailCode =
3308+
(typeof WorkspaceImageErrorDetailCode)[keyof typeof WorkspaceImageErrorDetailCode];
3309+
3310+
/**
3311+
* @public
3312+
* <p>Provides in-depth details about the error. These details include the
3313+
* possible causes of the errors and troubleshooting information.</p>
3314+
*/
3315+
export interface ErrorDetails {
3316+
/**
3317+
* @public
3318+
* <p>Indicates the error code returned.</p>
3319+
*/
3320+
ErrorCode?: WorkspaceImageErrorDetailCode | string;
3321+
3322+
/**
3323+
* @public
3324+
* <p>The text of the error message related the error code.</p>
3325+
*/
3326+
ErrorMessage?: string;
3327+
}
3328+
32713329
/**
32723330
* @public
32733331
* <p>Describes whether a WorkSpace image needs to be updated with the latest drivers and
@@ -3366,6 +3424,12 @@ export interface WorkspaceImage {
33663424
* <p>The updates (if any) that are available for the specified image.</p>
33673425
*/
33683426
Updates?: UpdateResult;
3427+
3428+
/**
3429+
* @public
3430+
* <p>The details of the error returned for the image.</p>
3431+
*/
3432+
ErrorDetails?: ErrorDetails[];
33693433
}
33703434

33713435
/**

‎clients/client-workspaces/src/protocols/Aws_json1_1.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5403,6 +5403,10 @@ const de_DescribeWorkspaceSnapshotsResult = (
54035403

54045404
// de_DnsIpAddresses omitted.
54055405

5406+
// de_ErrorDetails omitted.
5407+
5408+
// de_ErrorDetailsList omitted.
5409+
54065410
// de_FailedCreateStandbyWorkspacesRequest omitted.
54075411

54085412
// de_FailedCreateStandbyWorkspacesRequestList omitted.
@@ -5626,6 +5630,7 @@ const de_WorkspaceImage = (output: any, context: __SerdeContext): WorkspaceImage
56265630
Created: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
56275631
Description: __expectString,
56285632
ErrorCode: __expectString,
5633+
ErrorDetails: _json,
56295634
ErrorMessage: __expectString,
56305635
ImageId: __expectString,
56315636
Name: __expectString,

‎codegen/sdk-codegen/aws-models/workspaces.json

Lines changed: 194 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3589,6 +3589,32 @@
35893589
"smithy.api#pattern": "^ami\\-([a-f0-9]{8}|[a-f0-9]{17})$"
35903590
}
35913591
},
3592+
"com.amazonaws.workspaces#ErrorDetails": {
3593+
"type": "structure",
3594+
"members": {
3595+
"ErrorCode": {
3596+
"target": "com.amazonaws.workspaces#WorkspaceImageErrorDetailCode",
3597+
"traits": {
3598+
"smithy.api#documentation": "<p>Indicates the error code returned.</p>"
3599+
}
3600+
},
3601+
"ErrorMessage": {
3602+
"target": "com.amazonaws.workspaces#Description",
3603+
"traits": {
3604+
"smithy.api#documentation": "<p>The text of the error message related the error code.</p>"
3605+
}
3606+
}
3607+
},
3608+
"traits": {
3609+
"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>"
3610+
}
3611+
},
3612+
"com.amazonaws.workspaces#ErrorDetailsList": {
3613+
"type": "list",
3614+
"member": {
3615+
"target": "com.amazonaws.workspaces#ErrorDetails"
3616+
}
3617+
},
35923618
"com.amazonaws.workspaces#ErrorType": {
35933619
"type": "string"
35943620
},
@@ -7155,6 +7181,12 @@
71557181
"traits": {
71567182
"smithy.api#documentation": "<p>The updates (if any) that are available for the specified image.</p>"
71577183
}
7184+
},
7185+
"ErrorDetails": {
7186+
"target": "com.amazonaws.workspaces#ErrorDetailsList",
7187+
"traits": {
7188+
"smithy.api#documentation": "<p>The details of the error returned for the image.</p>"
7189+
}
71587190
}
71597191
},
71607192
"traits": {
@@ -7174,6 +7206,167 @@
71747206
"com.amazonaws.workspaces#WorkspaceImageErrorCode": {
71757207
"type": "string"
71767208
},
7209+
"com.amazonaws.workspaces#WorkspaceImageErrorDetailCode": {
7210+
"type": "enum",
7211+
"members": {
7212+
"OUTDATED_POWERSHELL_VERSION": {
7213+
"target": "smithy.api#Unit",
7214+
"traits": {
7215+
"smithy.api#enumValue": "OutdatedPowershellVersion"
7216+
}
7217+
},
7218+
"OFFICE_INSTALLED": {
7219+
"target": "smithy.api#Unit",
7220+
"traits": {
7221+
"smithy.api#enumValue": "OfficeInstalled"
7222+
}
7223+
},
7224+
"PCOIP_AGENT_INSTALLED": {
7225+
"target": "smithy.api#Unit",
7226+
"traits": {
7227+
"smithy.api#enumValue": "PCoIPAgentInstalled"
7228+
}
7229+
},
7230+
"WINDOWS_UPDATES_ENABLED": {
7231+
"target": "smithy.api#Unit",
7232+
"traits": {
7233+
"smithy.api#enumValue": "WindowsUpdatesEnabled"
7234+
}
7235+
},
7236+
"AUTO_MOUNT_DISABLED": {
7237+
"target": "smithy.api#Unit",
7238+
"traits": {
7239+
"smithy.api#enumValue": "AutoMountDisabled"
7240+
}
7241+
},
7242+
"WORKSPACES_BYOL_ACCOUNT_NOT_FOUND": {
7243+
"target": "smithy.api#Unit",
7244+
"traits": {
7245+
"smithy.api#enumValue": "WorkspacesBYOLAccountNotFound"
7246+
}
7247+
},
7248+
"WORKSPACES_BYOL_ACCOUNT_DISABLED": {
7249+
"target": "smithy.api#Unit",
7250+
"traits": {
7251+
"smithy.api#enumValue": "WorkspacesBYOLAccountDisabled"
7252+
}
7253+
},
7254+
"DHCP_DISABLED": {
7255+
"target": "smithy.api#Unit",
7256+
"traits": {
7257+
"smithy.api#enumValue": "DHCPDisabled"
7258+
}
7259+
},
7260+
"DISK_FREE_SPACE": {
7261+
"target": "smithy.api#Unit",
7262+
"traits": {
7263+
"smithy.api#enumValue": "DiskFreeSpace"
7264+
}
7265+
},
7266+
"ADDITIONAL_DRIVES_ATTACHED": {
7267+
"target": "smithy.api#Unit",
7268+
"traits": {
7269+
"smithy.api#enumValue": "AdditionalDrivesAttached"
7270+
}
7271+
},
7272+
"OS_NOT_SUPPORTED": {
7273+
"target": "smithy.api#Unit",
7274+
"traits": {
7275+
"smithy.api#enumValue": "OSNotSupported"
7276+
}
7277+
},
7278+
"DOMAIN_JOINED": {
7279+
"target": "smithy.api#Unit",
7280+
"traits": {
7281+
"smithy.api#enumValue": "DomainJoined"
7282+
}
7283+
},
7284+
"AZURE_DOMAIN_JOINED": {
7285+
"target": "smithy.api#Unit",
7286+
"traits": {
7287+
"smithy.api#enumValue": "AzureDomainJoined"
7288+
}
7289+
},
7290+
"FIREWALL_ENABLED": {
7291+
"target": "smithy.api#Unit",
7292+
"traits": {
7293+
"smithy.api#enumValue": "FirewallEnabled"
7294+
}
7295+
},
7296+
"VMWARE_TOOLS_INSTALLED": {
7297+
"target": "smithy.api#Unit",
7298+
"traits": {
7299+
"smithy.api#enumValue": "VMWareToolsInstalled"
7300+
}
7301+
},
7302+
"DISK_SIZE_EXCEEDED": {
7303+
"target": "smithy.api#Unit",
7304+
"traits": {
7305+
"smithy.api#enumValue": "DiskSizeExceeded"
7306+
}
7307+
},
7308+
"INCOMPATIBLE_PARTITIONING": {
7309+
"target": "smithy.api#Unit",
7310+
"traits": {
7311+
"smithy.api#enumValue": "IncompatiblePartitioning"
7312+
}
7313+
},
7314+
"PENDING_REBOOT": {
7315+
"target": "smithy.api#Unit",
7316+
"traits": {
7317+
"smithy.api#enumValue": "PendingReboot"
7318+
}
7319+
},
7320+
"AUTO_LOGON_ENABLED": {
7321+
"target": "smithy.api#Unit",
7322+
"traits": {
7323+
"smithy.api#enumValue": "AutoLogonEnabled"
7324+
}
7325+
},
7326+
"REALTIME_UNIVERSAL_DISABLED": {
7327+
"target": "smithy.api#Unit",
7328+
"traits": {
7329+
"smithy.api#enumValue": "RealTimeUniversalDisabled"
7330+
}
7331+
},
7332+
"MULTIPLE_BOOT_PARTITION": {
7333+
"target": "smithy.api#Unit",
7334+
"traits": {
7335+
"smithy.api#enumValue": "MultipleBootPartition"
7336+
}
7337+
},
7338+
"SIXTY_FOUR_BIT_OS": {
7339+
"target": "smithy.api#Unit",
7340+
"traits": {
7341+
"smithy.api#enumValue": "Requires64BitOS"
7342+
}
7343+
},
7344+
"ZERO_REARM_COUNT": {
7345+
"target": "smithy.api#Unit",
7346+
"traits": {
7347+
"smithy.api#enumValue": "ZeroRearmCount"
7348+
}
7349+
},
7350+
"IN_PLACE_UPGRADE": {
7351+
"target": "smithy.api#Unit",
7352+
"traits": {
7353+
"smithy.api#enumValue": "InPlaceUpgrade"
7354+
}
7355+
},
7356+
"ANTI_VIRUS_INSTALLED": {
7357+
"target": "smithy.api#Unit",
7358+
"traits": {
7359+
"smithy.api#enumValue": "AntiVirusInstalled"
7360+
}
7361+
},
7362+
"UEFI_NOT_SUPPORTED": {
7363+
"target": "smithy.api#Unit",
7364+
"traits": {
7365+
"smithy.api#enumValue": "UEFINotSupported"
7366+
}
7367+
}
7368+
}
7369+
},
71777370
"com.amazonaws.workspaces#WorkspaceImageId": {
71787371
"type": "string",
71797372
"traits": {
@@ -8616,4 +8809,4 @@
86168809
}
86178810
}
86188811
}
8619-
}
8812+
}

0 commit comments

Comments
 (0)