AWS API Changes

2025/08/14 - Amazon WorkSpaces - 2 new 2 updated api methods

Changes New APIs introduced to import WorkSpaces BYOL image using a new process that leveraged EC2 Image Builder. WorkSpaces tests and fixes your image's compatibility issues and supports customized VM images.

ImportCustomWorkspaceImage (new)

Link ¶

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces using EC2 Image Builder. The image must be an already licensed image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.

See also: AWS API Documentation

Request Syntax

client.import_custom_workspace_image(
    ImageName='string',
    ImageDescription='string',
    ComputeType='BASE'|'GRAPHICS_G4DN',
    Protocol='PCOIP'|'DCV'|'BYOP',
    ImageSource={
        'Ec2ImportTaskId': 'string',
        'ImageBuildVersionArn': 'string',
        'Ec2ImageId': 'string'
    },
    InfrastructureConfigurationArn='string',
    Platform='WINDOWS',
    OsVersion='Windows_10'|'Windows_11',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ImageName:

string

param ImageName:

[REQUIRED]

The name of the WorkSpace image.

type ImageDescription:

string

param ImageDescription:

[REQUIRED]

The description of the WorkSpace image.

type ComputeType:

string

param ComputeType:

[REQUIRED]

The supported compute type for the WorkSpace image.

type Protocol:

string

param Protocol:

[REQUIRED]

The supported protocol for the WorkSpace image. Windows 11 does not support PCOIP protocol.

type ImageSource:

dict

param ImageSource:

[REQUIRED]

The options for image import source.

Ec2ImportTaskId (string) --

The EC2 import task ID to import the image from the Amazon EC2 VM import process.
ImageBuildVersionArn (string) --

The ARN of the EC2 Image Builder image.
Ec2ImageId (string) --

The identifier of the EC2 image.

type InfrastructureConfigurationArn:

string

param InfrastructureConfigurationArn:

[REQUIRED]

The infrastructure configuration ARN that specifies how the WorkSpace image is built.

type Platform:

string

param Platform:

[REQUIRED]

The platform for the WorkSpace image source.

type OsVersion:

string

param OsVersion:

[REQUIRED]

The OS version for the WorkSpace image source.

type Tags:

list

param Tags:

The resource tags. Each WorkSpaces resource can have a maximum of 50 tags.

(dict) --

Describes a tag.
- Key (string) -- [REQUIRED]
  
  The key of the tag.
- Value (string) --
  
  The value of the tag.

rtype:

dict

returns:

Response Syntax

{
    'ImageId': 'string',
    'State': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'ERROR'
}

Response Structure

(dict) --
- ImageId (string) --
  
  The identifier of the WorkSpace image.
- State (string) --
  
  The state of the WorkSpace image.

DescribeCustomWorkspaceImageImport (new)

Link ¶

Retrieves information about a WorkSpace BYOL image being imported via ImportCustomWorkspaceImage.

See also: AWS API Documentation

Request Syntax

client.describe_custom_workspace_image_import(
    ImageId='string'
)

type ImageId:

string

param ImageId:

[REQUIRED]

The identifier of the WorkSpace image.

rtype:

dict

returns:

Response Syntax

{
    'ImageId': 'string',
    'InfrastructureConfigurationArn': 'string',
    'State': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'ERROR',
    'Created': datetime(2015, 1, 1),
    'LastUpdatedTime': datetime(2015, 1, 1),
    'ImageSource': {
        'Ec2ImportTaskId': 'string',
        'ImageBuildVersionArn': 'string',
        'Ec2ImageId': 'string'
    },
    'ImageBuilderInstanceId': 'string',
    'ErrorDetails': [
        {
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- ImageId (string) --
  
  The identifier of the WorkSpace image.
- InfrastructureConfigurationArn (string) --
  
  The infrastructure configuration ARN that specifies how the WorkSpace image is built.
- State (string) --
  
  The state of the WorkSpace image.
- Created (datetime) --
  
  The timestamp when the WorkSpace image import was created.
- LastUpdatedTime (datetime) --
  
  The timestamp when the WorkSpace image import was last updated.
- ImageSource (dict) --
  
  Describes the image import source.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: Ec2ImportTaskId, ImageBuildVersionArn, Ec2ImageId. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - Ec2ImportTaskId (string) --
    
    The EC2 import task ID to import the image from the Amazon EC2 VM import process.
  - ImageBuildVersionArn (string) --
    
    The ARN of the EC2 Image Builder image.
  - Ec2ImageId (string) --
    
    The identifier of the EC2 image.
- ImageBuilderInstanceId (string) --
  
  The image builder instance ID of the WorkSpace image.
- ErrorDetails (list) --
  
  Describes in-depth details about the error. These details include the possible causes of the error 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) --
      
      The error code that is returned for the image import.
    - ErrorMessage (string) --
      
      The text of the error message that is returned for the image import.

DescribeAccount (updated)

Link ¶
Changes (response)

{'Message': 'string'}

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.

See also: AWS API Documentation

Request Syntax

client.describe_account()

rtype:

dict

returns:

Response Syntax

{
    'DedicatedTenancySupport': 'ENABLED'|'DISABLED',
    'DedicatedTenancyManagementCidrRange': 'string',
    'DedicatedTenancyAccountType': 'SOURCE_ACCOUNT'|'TARGET_ACCOUNT',
    'Message': 'string'
}

Response Structure

(dict) --
- DedicatedTenancySupport (string) --
  
  The status of BYOL (whether BYOL is enabled or disabled).
- DedicatedTenancyManagementCidrRange (string) --
  
  The IP address range, specified as an IPv4 CIDR block, used for the management network interface.
  
  The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
- DedicatedTenancyAccountType (string) --
  
  The type of linked account.
- Message (string) --
  
  The text message to describe the status of BYOL.

ModifyAccount (updated)

Link ¶
Changes (response)

{'Message': 'string'}

Modifies the configuration of Bring Your Own License (BYOL) for the specified account.

See also: AWS API Documentation

Request Syntax

client.modify_account(
    DedicatedTenancySupport='ENABLED',
    DedicatedTenancyManagementCidrRange='string'
)

type DedicatedTenancySupport:

string

param DedicatedTenancySupport:

The status of BYOL.

type DedicatedTenancyManagementCidrRange:

string

param DedicatedTenancyManagementCidrRange:

The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the ListAvailableManagementCidrRanges operation.

rtype:

dict

returns:

Response Syntax

{
    'Message': 'string'
}

Response Structure

(dict) --
- Message (string) --
  
  The text message to describe the status of BYOL modification.