ImportVmImageRequest
¶
Source code in docs_src/capo_imagebuilder/types/import_vm_image_request.py
client_token
instance-attribute
¶
client_token: ClientToken
A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
description
instance-attribute
¶
description: NotRequired[NonEmptyString]
The description for the base image that is created by the import process.
logging_configuration
instance-attribute
¶
logging_configuration: NotRequired[ImageLoggingConfiguration]
The CloudWatch Logs log group where Image Builder sends the import logs. For ImportVmImage, the log group name must be within the /aws/imagebuilder/ namespace.
name
instance-attribute
¶
name: NonEmptyString
The name of the base image that is created by the import process. Image Builder generates the image ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If an image with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the import creates a new build version for it.
os_version
instance-attribute
¶
os_version: NotRequired[OsVersion]
The operating system version for the imported VM.
semantic_version
instance-attribute
¶
semantic_version: VersionNumber
The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.
The semantic version has four nodes:
Assignment: For the first three nodes, you can assign any positive integer value, including zero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
vm_import_task_id
instance-attribute
¶
vm_import_task_id: NonEmptyString
The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. The import task doesn't need to be complete when you call ImportVmImage - Image Builder monitors the task and finishes creating the image when the task completes.