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 .
See https://www.paws-r-sdk.com/docs/ec2_import_image/ for full documentation.
ec2_import_image(
Architecture = NULL,
ClientData = NULL,
ClientToken = NULL,
Description = NULL,
DiskContainers = NULL,
DryRun = NULL,
Encrypted = NULL,
Hypervisor = NULL,
KmsKeyId = NULL,
LicenseType = NULL,
Platform = NULL,
RoleName = NULL,
LicenseSpecifications = NULL,
TagSpecifications = NULL,
UsageOperation = NULL,
BootMode = NULL
)
The architecture of the virtual machine.
Valid values: i386
| x86_64
The client-specific data.
The token to enable idempotency for VM import requests.
A description string for the import image task.
Information about the disk containers.
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
.
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.
The target hypervisor platform.
Valid values: xen
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
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.
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.
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.
Valid values: Windows
| Linux
The name of the role to use when not using the default role, 'vmimport'.
The ARNs of the license configurations.
The tags to apply to the import image task during creation.
The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.
The boot mode of the virtual machine.
The uefi-preferred
boot mode isn't supported for importing images. For
more information, see Boot modes
in the VM Import/Export User Guide.