EC2 / Client / import_image

import_image#

EC2.Client.import_image(**kwargs)#

Note

To import your virtual machines (VMs) with a console-based experience, you can use the Import virtual machine images to Amazon Web Services template in the Migration Hub Orchestrator console. For more information, see the Migration Hub Orchestrator User Guide.

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

Warning

Amazon Web Services VM Import/Export strongly recommends specifying a value for either the --license-type or --usage-operation parameter when you create a new VM Import task. This ensures your operating system is licensed appropriately and your billing is optimized.

For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.

Request Syntax

response = client.import_image(
    Architecture='string',
    ClientData={
        'Comment': 'string',
        'UploadEnd': datetime(2015, 1, 1),
        'UploadSize': 123.0,
        'UploadStart': datetime(2015, 1, 1)
    },
    ClientToken='string',
    Description='string',
    DiskContainers=[
        {
            'Description': 'string',
            'DeviceName': 'string',
            'Format': 'string',
            'SnapshotId': 'string',
            'Url': 'string',
            'UserBucket': {
                'S3Bucket': 'string',
                'S3Key': 'string'
            }
        },
    ],
    DryRun=True|False,
    Encrypted=True|False,
    Hypervisor='string',
    KmsKeyId='string',
    LicenseType='string',
    Platform='string',
    RoleName='string',
    LicenseSpecifications=[
        {
            'LicenseConfigurationArn': 'string'
        },
    ],
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    UsageOperation='string',
    BootMode='legacy-bios'|'uefi'|'uefi-preferred'
)

Parameters:

Architecture (string) –
The architecture of the virtual machine.

Valid values: i386 | x86_64
ClientData (dict) –
The client-specific data.
- Comment (string) –
  
  A user-defined comment about the disk upload.
- UploadEnd (datetime) –
  
  The time that the disk upload ends.
- UploadSize (float) –
  
  The size of the uploaded disk image, in GiB.
- UploadStart (datetime) –
  
  The time that the disk upload starts.
ClientToken (string) – The token to enable idempotency for VM import requests.
Description (string) – A description string for the import image task.
DiskContainers (list) –
Information about the disk containers.
- (dict) –
  
  Describes the disk container object for an import image task.
  - Description (string) –
    
    The description of the disk image.
  - DeviceName (string) –
    
    The block device mapping for the disk.
  - Format (string) –
    
    The format of the disk image being imported.
    
    Valid values: OVA | VHD | VHDX | VMDK | RAW
  - SnapshotId (string) –
    
    The ID of the EBS snapshot to be used for importing the snapshot.
  - Url (string) –
    
    The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)
  - UserBucket (dict) –
    
    The S3 bucket for the disk image.
    - S3Bucket (string) –
      
      The name of the Amazon S3 bucket where the disk image is located.
    - S3Key (string) –
      
      The file name of the disk image.
DryRun (boolean) – 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 DryRunOperation. Otherwise, it is UnauthorizedOperation.
Encrypted (boolean) – 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 KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
Hypervisor (string) –
The target hypervisor platform.

Valid values: xen
KmsKeyId (string) –
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 KmsKeyId is specified, the Encrypted flag must also be set.

The KMS key identifier may be provided in any of the following formats:
- Key ID
- Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
- ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
- ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified KMS key must exist in the Region that the AMI is being copied to.

Amazon EBS does not support asymmetric KMS keys.
LicenseType (string) –
The license type to be used for the Amazon Machine Image (AMI) after importing.

Specify AWS to replace the source-system license with an Amazon Web Services license or BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing AWS when importing a Windows Server operating system, and the same as choosing BYOL when importing a Windows client operating system (such as Windows 10) or a Linux operating system.

To use BYOL, 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 Prerequisites in the VM Import/Export User Guide.
Platform (string) –
The operating system of the virtual machine.

Valid values: Windows | Linux
RoleName (string) – The name of the role to use when not using the default role, ‘vmimport’.
LicenseSpecifications (list) –
The ARNs of the license configurations.
- (dict) –
  
  The request information of license configurations.
  - LicenseConfigurationArn (string) –
    
    The ARN of a license configuration.
TagSpecifications (list) –
The tags to apply to the import image task during creation.
- (dict) –
  
  The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
  
  Note
  The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.
  - ResourceType (string) –
    
    The type of resource to tag on creation.
  - Tags (list) –
    
    The tags to apply to the resource.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
UsageOperation (string) – The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.
BootMode (string) – The boot mode of the virtual machine.

Return type:

dict

Returns:

Response Syntax

{
    'Architecture': 'string',
    'Description': 'string',
    'Encrypted': True|False,
    'Hypervisor': 'string',
    'ImageId': 'string',
    'ImportTaskId': 'string',
    'KmsKeyId': 'string',
    'LicenseType': 'string',
    'Platform': 'string',
    'Progress': 'string',
    'SnapshotDetails': [
        {
            'Description': 'string',
            'DeviceName': 'string',
            'DiskImageSize': 123.0,
            'Format': 'string',
            'Progress': 'string',
            'SnapshotId': 'string',
            'Status': 'string',
            'StatusMessage': 'string',
            'Url': 'string',
            'UserBucket': {
                'S3Bucket': 'string',
                'S3Key': 'string'
            }
        },
    ],
    'Status': 'string',
    'StatusMessage': 'string',
    'LicenseSpecifications': [
        {
            'LicenseConfigurationArn': 'string'
        },
    ],
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'UsageOperation': 'string'
}

Response Structure

(dict) –
- Architecture (string) –
  
  The architecture of the virtual machine.
- Description (string) –
  
  A description of the import task.
- Encrypted (boolean) –
  
  Indicates whether the AMI is encrypted.
- Hypervisor (string) –
  
  The target hypervisor of the import task.
- ImageId (string) –
  
  The ID of the Amazon Machine Image (AMI) created by the import task.
- ImportTaskId (string) –
  
  The task ID of the import image task.
- KmsKeyId (string) –
  
  The identifier for the symmetric KMS key that was used to create the encrypted AMI.
- LicenseType (string) –
  
  The license type of the virtual machine.
- Platform (string) –
  
  The operating system of the virtual machine.
- Progress (string) –
  
  The progress of the task.
- SnapshotDetails (list) –
  
  Information about the snapshots.
  - (dict) –
    
    Describes the snapshot created from the imported disk.
    - Description (string) –
      
      A description for the snapshot.
    - DeviceName (string) –
      
      The block device mapping for the snapshot.
    - DiskImageSize (float) –
      
      The size of the disk in the snapshot, in GiB.
    - Format (string) –
      
      The format of the disk image from which the snapshot is created.
    - Progress (string) –
      
      The percentage of progress for the task.
    - SnapshotId (string) –
      
      The snapshot ID of the disk being imported.
    - Status (string) –
      
      A brief status of the snapshot creation.
    - StatusMessage (string) –
      
      A detailed status message for the snapshot creation.
    - Url (string) –
      
      The URL used to access the disk image.
    - UserBucket (dict) –
      
      The Amazon S3 bucket for the disk image.
      - S3Bucket (string) –
        
        The Amazon S3 bucket from which the disk image was created.
      - S3Key (string) –
        
        The file name of the disk image.
- Status (string) –
  
  A brief status of the task.
- StatusMessage (string) –
  
  A detailed status message of the import task.
- LicenseSpecifications (list) –
  
  The ARNs of the license configurations.
  - (dict) –
    
    The response information for license configurations.
    - LicenseConfigurationArn (string) –
      
      The ARN of a license configuration.
- Tags (list) –
  
  Any tags assigned to the import image task.
  - (dict) –
    
    Describes a tag.
    - Key (string) –
      
      The key of the tag.
      
      Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
    - Value (string) –
      
      The value of the tag.
      
      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
- UsageOperation (string) –
  
  The usage operation value.