Describe Workspace Images

workspaces_describe_workspace_images

R Documentation

Retrieves a list that describes one or more specified images, if the image identifiers are provided¶

Description¶

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

Usage¶

workspaces_describe_workspace_images(ImageIds, ImageType, NextToken,
  MaxResults)

Arguments¶

ImageIds

The identifier of the image.

ImageType

The type (owned or shared) of the image.

NextToken

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

MaxResults

The maximum number of items to return.

Value¶

A list with the following syntax:

list(
  Images = list(
    list(
      ImageId = "string",
      Name = "string",
      Description = "string",
      OperatingSystem = list(
        Type = "WINDOWS"|"LINUX"
      ),
      State = "AVAILABLE"|"PENDING"|"ERROR",
      RequiredTenancy = "DEFAULT"|"DEDICATED",
      ErrorCode = "string",
      ErrorMessage = "string",
      Created = as.POSIXct(
        "2015-01-01"
      ),
      OwnerAccountId = "string",
      Updates = list(
        UpdateAvailable = TRUE|FALSE,
        Description = "string"
      ),
      ErrorDetails = list(
        list(
          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"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_workspace_images(
  ImageIds = list(
    "string"
  ),
  ImageType = "OWNED"|"SHARED",
  NextToken = "string",
  MaxResults = 123
)