EC2 Image Builder

{'registerImageOptions': {'secureBootEnabled': 'boolean', 'uefiData': 'string'},
 'windowsConfiguration': {'imageIndex': 'long'}}

Import a Windows operating system image from a verified Microsoft ISO disk file. The following disk images are supported:

• Windows 11 Enterprise

See also: AWS API Documentation

Request Syntax

client.import_disk_image(
    name='string',
    semanticVersion='string',
    description='string',
    platform='string',
    osVersion='string',
    executionRole='string',
    infrastructureConfigurationArn='string',
    uri='string',
    loggingConfiguration={
        'logGroupName': 'string'
    },
    tags={
        'string': 'string'
    },
    registerImageOptions={
        'secureBootEnabled': True|False,
        'uefiData': 'string'
    },
    windowsConfiguration={
        'imageIndex': 123
    },
    clientToken='string'
)

type name:

string

param name:

[REQUIRED]

The name of the image resource that's created from the import.

type semanticVersion:

string

param semanticVersion:

[REQUIRED]

The semantic version to attach to the image that's created during the import process. This version follows the semantic version syntax.

type description:

string

param description:

The description for your disk image import.

type platform:

string

param platform:

[REQUIRED]

The operating system platform for the imported image. Allowed values include the following: Windows.

type osVersion:

string

param osVersion:

[REQUIRED]

The operating system version for the imported image. Allowed values include the following: Microsoft Windows 11.

type executionRole:

string

param executionRole:

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions to import an image from a Microsoft ISO file.

type infrastructureConfigurationArn:

string

param infrastructureConfigurationArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the infrastructure configuration resource that's used for launching the EC2 instance on which the ISO image is built.

type uri:

string

param uri:

[REQUIRED]

The uri of the ISO disk file that's stored in Amazon S3.

type loggingConfiguration:

dict

param loggingConfiguration:

Define logging configuration for the image build process.

• logGroupName (string) --

  The log group name that Image Builder uses for image creation. If not specified, the log group name defaults to /aws/imagebuilder/image-name.

type tags:

dict

param tags:

Tags that are attached to image resources created from the import.

• (string) --

  • (string) --

type registerImageOptions:

dict

param registerImageOptions:

Configures Secure Boot and UEFI settings for the imported image.

• secureBootEnabled (boolean) --

  Specifies whether Secure Boot is enabled for the output AMI. The default value is true. To disable Secure Boot for custom unsigned drivers, set this value to false.

• uefiData (string) --

  A Base64-encoded representation of the non-volatile UEFI variable store. You can specify this parameter only when secureBootEnabled is true or unspecified. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub.

  For more information, see UEFI variables for Amazon EC2 instances.

type windowsConfiguration:

dict

param windowsConfiguration:

Specifies Windows settings for ISO imports.

• imageIndex (integer) -- [REQUIRED]

  The 1-based index that specifies which Windows edition to install from a multi-edition Windows ISO file. A Windows ISO can contain a .wim file with multiple image indexes, each representing a different edition.

type clientToken:

string

param clientToken:

[REQUIRED]

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'clientToken': 'string',
    'imageBuildVersionArn': 'string'
}

Response Structure

• (dict) --

  • clientToken (string) --

    The client token that uniquely identifies the request.

  • imageBuildVersionArn (string) --

    The Amazon Resource Name (ARN) of the output AMI that was created from the ISO disk file.