WorkSpaces / Client / describe_workspace_images

describe_workspace_images#

WorkSpaces.Client.describe_workspace_images(**kwargs)#

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

Request Syntax

response = client.describe_workspace_images(
    ImageIds=[
        'string',
    ],
    ImageType='OWNED'|'SHARED',
    NextToken='string',
    MaxResults=123
)

Parameters:

ImageIds (list) –
The identifier of the image.
- (string) –
ImageType (string) – The type (owned or shared) of the image.
NextToken (string) – If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
MaxResults (integer) – The maximum number of items to return.

Return type:

dict

Returns:

Response Syntax

{
    'Images': [
        {
            'ImageId': 'string',
            'Name': 'string',
            'Description': 'string',
            'OperatingSystem': {
                'Type': 'WINDOWS'|'LINUX'
            },
            'State': 'AVAILABLE'|'PENDING'|'ERROR',
            'RequiredTenancy': 'DEFAULT'|'DEDICATED',
            'ErrorCode': 'string',
            'ErrorMessage': 'string',
            'Created': datetime(2015, 1, 1),
            'OwnerAccountId': 'string',
            'Updates': {
                'UpdateAvailable': True|False,
                'Description': 'string'
            },
            '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'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Images (list) –
  
  Information about the images.
  - (dict) –
    
    Describes a WorkSpace image.
    - ImageId (string) –
      
      The identifier of the image.
    - Name (string) –
      
      The name of the image.
    - Description (string) –
      
      The description of the image.
    - OperatingSystem (dict) –
      
      The operating system that the image is running.
      - Type (string) –
        
        The operating system.
    - State (string) –
      
      The status of the image.
    - RequiredTenancy (string) –
      
      Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
    - ErrorCode (string) –
      
      The error code that is returned for the image.
    - ErrorMessage (string) –
      
      The text of the error message that is returned for the image.
    - Created (datetime) –
      
      The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.
    - OwnerAccountId (string) –
      
      The identifier of the Amazon Web Services account that owns the image.
    - Updates (dict) –
      
      The updates (if any) that are available for the specified image.
      - UpdateAvailable (boolean) –
        
        Indicates whether updated drivers or other components are available for the specified WorkSpace image.
      - Description (string) –
        
        A description of whether updates for the WorkSpace image are pending or available.
    - ErrorDetails (list) –
      
      Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.
      - (dict) –
        
        Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.
        
        ErrorCode (string) –
        
        Indicates the error code returned.
        
        ErrorMessage (string) –
        
        The text of the error message related the error code.
- NextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

WorkSpaces.Client.exceptions.AccessDeniedException