RegisterImage
Description
Registers an AMI with Amazon EC2. Images must be registered before they can be launched. To launch instances, use the RunInstances
operation.
Each AMI is associated with an unique ID which is provided by the Amazon EC2 service through the RegisterImage
operation. During registration, Amazon EC2 retrieves the specified image manifest from Amazon S3 and verifies that the image is owned by the user registering the image.
The image manifest is retrieved once and stored within the Amazon EC2. Any modifications to an image in Amazon S3 invalidates this registration. If you make changes to an image, deregister the previous image and register the new image. To deregister an image, use the DeregisterImage
operation.
Request Parameters
Name | Description | Required |
---|---|---|
|
Type: |
Ancestor: None
Children: imageLocation
imageLocation
Full path to your AMI manifest in Amazon S3 storage.
Type: xsd:string
Default: None
Ancestor: RegisterImage
Children: None
Yes
Response Elements
Name | Description |
---|---|
|
Type: RegisterImageResponse Ancestor: None Children: |
|
The ID of the request. Type: xsd:string Ancestor: Children: None |
|
Unique ID of the newly registered machine image. Type: xsd:string Ancestor: Children: None |
Examples
Example Request
This example registers the AMI specified in the image.manifest.xml
manifest file.
<RegisterImage xmlns="http://ec2.amazonaws.com/doc/2009-04-04/"> <imageLocation>/mybucket/myimage.manifest.xml</imageLocation> </RegisterImage>
Example Response
<RegisterImageResponse xmlns="http://ec2.amazonaws.com/doc/2009-04-04/"> <imageId>ami-61a54008</imageId> </RegisterImageResponse>