import_image ¶

def import_image(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    architecture: Optional["capo_ec2.types.string.String"] = None,
    client_data: Optional["capo_ec2.types.client_data.ClientData"] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
    description: Optional["capo_ec2.types.string.String"] = None,
    disk_containers: Optional[
        "capo_ec2.types.image_disk_container_list.ImageDiskContainerList"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    encrypted: Optional["capo_ec2.types.boolean.Boolean"] = None,
    hypervisor: Optional["capo_ec2.types.string.String"] = None,
    kms_key_id: Optional["capo_ec2.types.kms_key_id.KmsKeyId"] = None,
    license_type: Optional["capo_ec2.types.string.String"] = None,
    platform: Optional["capo_ec2.types.string.String"] = None,
    role_name: Optional["capo_ec2.types.string.String"] = None,
    license_specifications: Optional[
        "capo_ec2.types.import_image_license_specification_list_request.ImportImageLicenseSpecificationListRequest"
    ] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
    usage_operation: Optional["capo_ec2.types.string.String"] = None,
    boot_mode: Optional["capo_ec2.types.boot_mode_values.BootModeValues"] = None,
) -> "capo_ec2.types.import_image_result.ImportImageResult":
    """<note> <p>To import your virtual machines (VMs) with a console-based experience, you can use the <i>Import virtual machine images to Amazon Web Services</i> template in the <a href="https://console.aws.amazon.com/migrationhub/orchestrator">Migration Hub Orchestrator console</a>. For more information, see the <a href="https://docs.aws.amazon.com/migrationhub-orchestrator/latest/userguide/import-vm-images.html"> <i>Migration Hub Orchestrator User Guide</i> </a>.</p> </note> <p>Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).</p> <important> <p>Amazon Web Services VM Import/Export strongly recommends specifying a value for either the <code>--license-type</code> or <code>--usage-operation</code> parameter when you create a new VM Import task. This ensures your operating system is licensed appropriately and your billing is optimized.</p> </important> <p>For more information, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html">Importing a VM as an image using VM Import/Export</a> in the <i>VM Import/Export User Guide</i>.</p>

    Args:
        architecture: <p>The architecture of the virtual machine.</p> <p>Valid values: <code>i386</code> | <code>x86_64</code> </p>
        client_data: <p>The client-specific data.</p>
        client_token: <p>The token to enable idempotency for VM import requests.</p>
        description: <p>A description string for the import image task.</p>
        disk_containers: <p>Information about the disk containers.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        encrypted: <p>Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using <code>KmsKeyId</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
        hypervisor: <p>The target hypervisor platform.</p> <p>Valid values: <code>xen</code> </p>
        kms_key_id: <p>An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a <code>KmsKeyId</code> is specified, the <code>Encrypted</code> flag must also be set. </p> <p>The KMS key identifier may be provided in any of the following formats: </p> <ul> <li> <p>Key ID</p> </li> <li> <p>Key alias</p> </li> <li> <p>ARN using key ID. The ID ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>key</code> namespace, and then the key ID. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:key/<i>abcd1234-a123-456a-a12b-a123b4cd56ef</i>.</p> </li> <li> <p>ARN using key alias. The alias ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>alias</code> namespace, and then the key alias. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:alias/<i>ExampleAlias</i>. </p> </li> </ul> <p>Amazon Web Services parses <code>KmsKeyId</code> asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure. </p> <p>The specified KMS key must exist in the Region that the AMI is being copied to.</p> <p>Amazon EBS does not support asymmetric KMS keys.</p>
        license_type: <p>The license type to be used for the Amazon Machine Image (AMI) after importing.</p> <p>Specify <code>AWS</code> to replace the source-system license with an Amazon Web Services license or <code>BYOL</code> to retain the source-system license. Leaving this parameter undefined is the same as choosing <code>AWS</code> when importing a Windows Server operating system, and the same as choosing <code>BYOL</code> when importing a Windows client operating system (such as Windows 10) or a Linux operating system.</p> <p>To use <code>BYOL</code>, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html#prerequisites-image">Prerequisites</a> in the VM Import/Export User Guide.</p>
        platform: <p>The operating system of the virtual machine. If you import a VM that is compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the platform.</p> <p>Valid values: <code>Windows</code> | <code>Linux</code> </p>
        role_name: <p>The name of the role to use when not using the default role, 'vmimport'.</p>
        license_specifications: <p>The ARNs of the license configurations.</p>
        tag_specifications: <p>The tags to apply to the import image task during creation.</p>
        usage_operation: <p>The usage operation value. For more information, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#prerequisites">Licensing options</a> in the <i>VM Import/Export User Guide</i>.</p>
        boot_mode: <p>The boot mode of the virtual machine.</p> <note> <p>The <code>uefi-preferred</code> boot mode isn't supported for importing images. For more information, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/prerequisites.html#vmimport-boot-modes">Boot modes</a> in the <i>VM Import/Export User Guide</i>.</p> </note>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.import_image_request.ImportImageRequest]",
    ) -> OperationResponse["capo_ec2.types.import_image_result.ImportImageResult"]:
        import capo_ec2._operations.amazon_ec2.import_image

        output, http_response = (
            capo_ec2._operations.amazon_ec2.import_image.import_image(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_ec2.types.import_image_request.ImportImageRequest",
    ) -> dict[str, Any]:
        import capo_ec2.types.import_image_request

        return capo_ec2.types.import_image_request.redact_sensitive(input_)

    def _redact_output(
        output: "capo_ec2.types.import_image_result.ImportImageResult",
    ) -> dict[str, Any]:
        import capo_ec2.types.import_image_result

        return capo_ec2.types.import_image_result.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ImportImage", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_ec2.types.import_image_request.ImportImageRequest = {}
    if architecture is not None:
        input_["architecture"] = architecture
    if client_data is not None:
        input_["client_data"] = client_data
    if client_token is not None:
        input_["client_token"] = client_token
    if description is not None:
        input_["description"] = description
    if disk_containers is not None:
        input_["disk_containers"] = disk_containers
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if encrypted is not None:
        input_["encrypted"] = encrypted
    if hypervisor is not None:
        input_["hypervisor"] = hypervisor
    if kms_key_id is not None:
        input_["kms_key_id"] = kms_key_id
    if license_type is not None:
        input_["license_type"] = license_type
    if platform is not None:
        input_["platform"] = platform
    if role_name is not None:
        input_["role_name"] = role_name
    if license_specifications is not None:
        input_["license_specifications"] = license_specifications
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications
    if usage_operation is not None:
        input_["usage_operation"] = usage_operation
    if boot_mode is not None:
        input_["boot_mode"] = boot_mode

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output