Use RegisterImage with an AWS SDK or CLI

The following code examples show how to use RegisterImage.

CLI

AWS CLI

Example 1: To register an AMI using a manifest file

The following register-image example registers an AMI using the specified manifest file in Amazon S3.

aws ec2 register-image \
    --name my-image \
    --image-location my-s3-bucket/myimage/image.manifest.xml

Output:

{
    "ImageId": "ami-1234567890EXAMPLE"
}

For more information, see Amazon Machine Images (AMI) in the Amazon EC2 User Guide.

Example 2: To register an AMI using a snapshot of a root device

The following register-image example registers an AMI using the specified snapshot of an EBS root volume as device /dev/xvda. The block device mapping also includes an empty 100 GiB EBS volume as device /dev/xvdf.

aws ec2 register-image \
    --name my-image \
    --root-device-name /dev/xvda \
    --block-device-mappings DeviceName=/dev/xvda,Ebs={SnapshotId=snap-0db2cf683925d191f} DeviceName=/dev/xvdf,Ebs={VolumeSize=100}

Output:

{
    "ImageId": "ami-1a2b3c4d5eEXAMPLE"
}

For more information, see Amazon Machine Images (AMI) in the Amazon EC2 User Guide.

• For API details, see RegisterImage in AWS CLI Command Reference.

PowerShell

Tools for PowerShell

Example 1: This example registers an AMI using the specified manifest file in Amazon S3.

Register-EC2Image -ImageLocation my-s3-bucket/my-web-server-ami/image.manifest.xml -Name my-web-server-ami

• For API details, see RegisterImage in AWS Tools for PowerShell Cmdlet Reference.