DescribeWorkspaceImagesCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkSpacesClient, DescribeWorkspaceImagesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import
// const { WorkSpacesClient, DescribeWorkspaceImagesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import
const client = new WorkSpacesClient(config);
const input = { // DescribeWorkspaceImagesRequest
  ImageIds: [ // WorkspaceImageIdList
    "STRING_VALUE",
  ],
  ImageType: "OWNED" || "SHARED",
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new DescribeWorkspaceImagesCommand(input);
const response = await client.send(command);
// { // DescribeWorkspaceImagesResult
//   Images: [ // WorkspaceImageList
//     { // WorkspaceImage
//       ImageId: "STRING_VALUE",
//       Name: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       OperatingSystem: { // OperatingSystem
//         Type: "WINDOWS" || "LINUX",
//       },
//       State: "AVAILABLE" || "PENDING" || "ERROR",
//       RequiredTenancy: "DEFAULT" || "DEDICATED",
//       ErrorCode: "STRING_VALUE",
//       ErrorMessage: "STRING_VALUE",
//       Created: new Date("TIMESTAMP"),
//       OwnerAccountId: "STRING_VALUE",
//       Updates: { // UpdateResult
//         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" || "UnknownError" || "AppXPackagesInstalled" || "ReservedStorageInUse" || "AdditionalDrivesPresent" || "WindowsUpdatesRequired" || "SysPrepFileMissing" || "UserProfileMissing" || "InsufficientDiskSpace" || "EnvironmentVariablesPathMissingEntries" || "DomainAccountServicesFound" || "InvalidIp" || "RemoteDesktopServicesDisabled" || "WindowsModulesInstallerDisabled" || "AmazonSsmAgentEnabled" || "UnsupportedSecurityProtocol" || "MultipleUserProfiles" || "StagedAppxPackage" || "UnsupportedOsUpgrade" || "InsufficientRearmCount",
//           ErrorMessage: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeWorkspaceImagesCommand Input

See DescribeWorkspaceImagesCommandInput for more details

Parameter
Type
Description
ImageIds
string[] | undefined

The identifier of the image.

ImageType
ImageType | undefined

The type (owned or shared) of the image.

MaxResults
number | undefined

The maximum number of items to return.

NextToken
string | undefined

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

DescribeWorkspaceImagesCommand Output

See DescribeWorkspaceImagesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Images
WorkspaceImage[] | undefined

Information about the images.

NextToken
string | undefined

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

Throws

Name
Fault
Details
AccessDeniedException
client

The user is not authorized to access a resource.

WorkSpacesServiceException
Base exception class for all service exceptions from WorkSpaces service.